fidl_fuchsia_component_resolution_common/
fidl_fuchsia_component_resolution_common.rs

1// WARNING: This file is machine generated by fidlgen.
2
3#![warn(clippy::all)]
4#![allow(unused_parens, unused_mut, unused_imports, nonstandard_style)]
5
6use bitflags::bitflags;
7use fidl::encoding::{MessageBufFor, ProxyChannelBox, ResourceDialect};
8use futures::future::{self, MaybeDone, TryFutureExt};
9use zx_status;
10
11/// Max length of component URL.
12pub const MAX_COMPONENT_URL_LENGTH: u32 = 2083;
13
14/// The maximum number of bytes for a `Context`.
15pub const MAX_RESOLUTION_CONTEXT_SIZE: u32 = 8192;
16
17/// The possible error conditions returned by ComponentResolver.
18#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
19#[repr(u32)]
20pub enum ResolverError {
21    /// An unexpected error occurred.
22    Internal = 1,
23    /// A general IO error occurred.
24    Io = 2,
25    /// The component URL was malformed.
26    InvalidArgs = 3,
27    /// The repository specified in the URL is unsupported.
28    NotSupported = 4,
29    /// The component manifest was not found.
30    ManifestNotFound = 5,
31    /// The component's package was not found.
32    PackageNotFound = 6,
33    /// Insufficient space on device to store component's package.
34    NoSpace = 7,
35    /// The component is temporarily unavailable.
36    ResourceUnavailable = 8,
37    /// The component manifest could not be parsed or it contained invalid configuration.
38    InvalidManifest = 9,
39    /// The component specifies configuration fields but the values were not found.
40    ConfigValuesNotFound = 10,
41    /// The ABI revision file could not be found.
42    AbiRevisionNotFound = 11,
43    /// The ABI revision value could not be parsed.
44    InvalidAbiRevision = 12,
45}
46
47impl ResolverError {
48    #[inline]
49    pub fn from_primitive(prim: u32) -> Option<Self> {
50        match prim {
51            1 => Some(Self::Internal),
52            2 => Some(Self::Io),
53            3 => Some(Self::InvalidArgs),
54            4 => Some(Self::NotSupported),
55            5 => Some(Self::ManifestNotFound),
56            6 => Some(Self::PackageNotFound),
57            7 => Some(Self::NoSpace),
58            8 => Some(Self::ResourceUnavailable),
59            9 => Some(Self::InvalidManifest),
60            10 => Some(Self::ConfigValuesNotFound),
61            11 => Some(Self::AbiRevisionNotFound),
62            12 => Some(Self::InvalidAbiRevision),
63            _ => None,
64        }
65    }
66
67    #[inline]
68    pub const fn into_primitive(self) -> u32 {
69        self as u32
70    }
71
72    #[deprecated = "Strict enums should not use `is_unknown`"]
73    #[inline]
74    pub fn is_unknown(&self) -> bool {
75        false
76    }
77}
78
79/// A component resolution context, used when resolving component URLs relative
80/// to another component. The context is stored in a byte array that persists a
81/// value used by the target `Resolver` to locate and resolve a component by
82/// relative path (for example, by a subpackage name).
83#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
84pub struct Context {
85    pub bytes: Vec<u8>,
86}
87
88impl fidl::Persistable for Context {}
89
90#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
91pub struct ResolverResolveRequest {
92    pub component_url: String,
93}
94
95impl fidl::Persistable for ResolverResolveRequest {}
96
97#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
98pub struct ResolverResolveWithContextRequest {
99    pub component_url: String,
100    pub context: Context,
101}
102
103impl fidl::Persistable for ResolverResolveWithContextRequest {}
104
105mod internal {
106    use super::*;
107    unsafe impl fidl::encoding::TypeMarker for ResolverError {
108        type Owned = Self;
109
110        #[inline(always)]
111        fn inline_align(_context: fidl::encoding::Context) -> usize {
112            std::mem::align_of::<u32>()
113        }
114
115        #[inline(always)]
116        fn inline_size(_context: fidl::encoding::Context) -> usize {
117            std::mem::size_of::<u32>()
118        }
119
120        #[inline(always)]
121        fn encode_is_copy() -> bool {
122            true
123        }
124
125        #[inline(always)]
126        fn decode_is_copy() -> bool {
127            false
128        }
129    }
130
131    impl fidl::encoding::ValueTypeMarker for ResolverError {
132        type Borrowed<'a> = Self;
133        #[inline(always)]
134        fn borrow(value: &<Self as fidl::encoding::TypeMarker>::Owned) -> Self::Borrowed<'_> {
135            *value
136        }
137    }
138
139    unsafe impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Encode<Self, D> for ResolverError {
140        #[inline]
141        unsafe fn encode(
142            self,
143            encoder: &mut fidl::encoding::Encoder<'_, D>,
144            offset: usize,
145            _depth: fidl::encoding::Depth,
146        ) -> fidl::Result<()> {
147            encoder.debug_check_bounds::<Self>(offset);
148            encoder.write_num(self.into_primitive(), offset);
149            Ok(())
150        }
151    }
152
153    impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Decode<Self, D> for ResolverError {
154        #[inline(always)]
155        fn new_empty() -> Self {
156            Self::Internal
157        }
158
159        #[inline]
160        unsafe fn decode(
161            &mut self,
162            decoder: &mut fidl::encoding::Decoder<'_, D>,
163            offset: usize,
164            _depth: fidl::encoding::Depth,
165        ) -> fidl::Result<()> {
166            decoder.debug_check_bounds::<Self>(offset);
167            let prim = decoder.read_num::<u32>(offset);
168
169            *self = Self::from_primitive(prim).ok_or(fidl::Error::InvalidEnumValue)?;
170            Ok(())
171        }
172    }
173
174    impl fidl::encoding::ValueTypeMarker for Context {
175        type Borrowed<'a> = &'a Self;
176        fn borrow(value: &<Self as fidl::encoding::TypeMarker>::Owned) -> Self::Borrowed<'_> {
177            value
178        }
179    }
180
181    unsafe impl fidl::encoding::TypeMarker for Context {
182        type Owned = Self;
183
184        #[inline(always)]
185        fn inline_align(_context: fidl::encoding::Context) -> usize {
186            8
187        }
188
189        #[inline(always)]
190        fn inline_size(_context: fidl::encoding::Context) -> usize {
191            16
192        }
193    }
194
195    unsafe impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Encode<Context, D> for &Context {
196        #[inline]
197        unsafe fn encode(
198            self,
199            encoder: &mut fidl::encoding::Encoder<'_, D>,
200            offset: usize,
201            _depth: fidl::encoding::Depth,
202        ) -> fidl::Result<()> {
203            encoder.debug_check_bounds::<Context>(offset);
204            // Delegate to tuple encoding.
205            fidl::encoding::Encode::<Context, D>::encode(
206                (<fidl::encoding::Vector<u8, 8192> as fidl::encoding::ValueTypeMarker>::borrow(
207                    &self.bytes,
208                ),),
209                encoder,
210                offset,
211                _depth,
212            )
213        }
214    }
215    unsafe impl<
216            D: fidl::encoding::ResourceDialect,
217            T0: fidl::encoding::Encode<fidl::encoding::Vector<u8, 8192>, D>,
218        > fidl::encoding::Encode<Context, D> for (T0,)
219    {
220        #[inline]
221        unsafe fn encode(
222            self,
223            encoder: &mut fidl::encoding::Encoder<'_, D>,
224            offset: usize,
225            depth: fidl::encoding::Depth,
226        ) -> fidl::Result<()> {
227            encoder.debug_check_bounds::<Context>(offset);
228            // Zero out padding regions. There's no need to apply masks
229            // because the unmasked parts will be overwritten by fields.
230            // Write the fields.
231            self.0.encode(encoder, offset + 0, depth)?;
232            Ok(())
233        }
234    }
235
236    impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Decode<Self, D> for Context {
237        #[inline(always)]
238        fn new_empty() -> Self {
239            Self { bytes: fidl::new_empty!(fidl::encoding::Vector<u8, 8192>, D) }
240        }
241
242        #[inline]
243        unsafe fn decode(
244            &mut self,
245            decoder: &mut fidl::encoding::Decoder<'_, D>,
246            offset: usize,
247            _depth: fidl::encoding::Depth,
248        ) -> fidl::Result<()> {
249            decoder.debug_check_bounds::<Self>(offset);
250            // Verify that padding bytes are zero.
251            fidl::decode!(fidl::encoding::Vector<u8, 8192>, D, &mut self.bytes, decoder, offset + 0, _depth)?;
252            Ok(())
253        }
254    }
255
256    impl fidl::encoding::ValueTypeMarker for ResolverResolveRequest {
257        type Borrowed<'a> = &'a Self;
258        fn borrow(value: &<Self as fidl::encoding::TypeMarker>::Owned) -> Self::Borrowed<'_> {
259            value
260        }
261    }
262
263    unsafe impl fidl::encoding::TypeMarker for ResolverResolveRequest {
264        type Owned = Self;
265
266        #[inline(always)]
267        fn inline_align(_context: fidl::encoding::Context) -> usize {
268            8
269        }
270
271        #[inline(always)]
272        fn inline_size(_context: fidl::encoding::Context) -> usize {
273            16
274        }
275    }
276
277    unsafe impl<D: fidl::encoding::ResourceDialect>
278        fidl::encoding::Encode<ResolverResolveRequest, D> for &ResolverResolveRequest
279    {
280        #[inline]
281        unsafe fn encode(
282            self,
283            encoder: &mut fidl::encoding::Encoder<'_, D>,
284            offset: usize,
285            _depth: fidl::encoding::Depth,
286        ) -> fidl::Result<()> {
287            encoder.debug_check_bounds::<ResolverResolveRequest>(offset);
288            // Delegate to tuple encoding.
289            fidl::encoding::Encode::<ResolverResolveRequest, D>::encode(
290                (<fidl::encoding::BoundedString<2083> as fidl::encoding::ValueTypeMarker>::borrow(
291                    &self.component_url,
292                ),),
293                encoder,
294                offset,
295                _depth,
296            )
297        }
298    }
299    unsafe impl<
300            D: fidl::encoding::ResourceDialect,
301            T0: fidl::encoding::Encode<fidl::encoding::BoundedString<2083>, D>,
302        > fidl::encoding::Encode<ResolverResolveRequest, D> for (T0,)
303    {
304        #[inline]
305        unsafe fn encode(
306            self,
307            encoder: &mut fidl::encoding::Encoder<'_, D>,
308            offset: usize,
309            depth: fidl::encoding::Depth,
310        ) -> fidl::Result<()> {
311            encoder.debug_check_bounds::<ResolverResolveRequest>(offset);
312            // Zero out padding regions. There's no need to apply masks
313            // because the unmasked parts will be overwritten by fields.
314            // Write the fields.
315            self.0.encode(encoder, offset + 0, depth)?;
316            Ok(())
317        }
318    }
319
320    impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Decode<Self, D>
321        for ResolverResolveRequest
322    {
323        #[inline(always)]
324        fn new_empty() -> Self {
325            Self { component_url: fidl::new_empty!(fidl::encoding::BoundedString<2083>, D) }
326        }
327
328        #[inline]
329        unsafe fn decode(
330            &mut self,
331            decoder: &mut fidl::encoding::Decoder<'_, D>,
332            offset: usize,
333            _depth: fidl::encoding::Depth,
334        ) -> fidl::Result<()> {
335            decoder.debug_check_bounds::<Self>(offset);
336            // Verify that padding bytes are zero.
337            fidl::decode!(
338                fidl::encoding::BoundedString<2083>,
339                D,
340                &mut self.component_url,
341                decoder,
342                offset + 0,
343                _depth
344            )?;
345            Ok(())
346        }
347    }
348
349    impl fidl::encoding::ValueTypeMarker for ResolverResolveWithContextRequest {
350        type Borrowed<'a> = &'a Self;
351        fn borrow(value: &<Self as fidl::encoding::TypeMarker>::Owned) -> Self::Borrowed<'_> {
352            value
353        }
354    }
355
356    unsafe impl fidl::encoding::TypeMarker for ResolverResolveWithContextRequest {
357        type Owned = Self;
358
359        #[inline(always)]
360        fn inline_align(_context: fidl::encoding::Context) -> usize {
361            8
362        }
363
364        #[inline(always)]
365        fn inline_size(_context: fidl::encoding::Context) -> usize {
366            32
367        }
368    }
369
370    unsafe impl<D: fidl::encoding::ResourceDialect>
371        fidl::encoding::Encode<ResolverResolveWithContextRequest, D>
372        for &ResolverResolveWithContextRequest
373    {
374        #[inline]
375        unsafe fn encode(
376            self,
377            encoder: &mut fidl::encoding::Encoder<'_, D>,
378            offset: usize,
379            _depth: fidl::encoding::Depth,
380        ) -> fidl::Result<()> {
381            encoder.debug_check_bounds::<ResolverResolveWithContextRequest>(offset);
382            // Delegate to tuple encoding.
383            fidl::encoding::Encode::<ResolverResolveWithContextRequest, D>::encode(
384                (
385                    <fidl::encoding::BoundedString<2083> as fidl::encoding::ValueTypeMarker>::borrow(&self.component_url),
386                    <Context as fidl::encoding::ValueTypeMarker>::borrow(&self.context),
387                ),
388                encoder, offset, _depth
389            )
390        }
391    }
392    unsafe impl<
393            D: fidl::encoding::ResourceDialect,
394            T0: fidl::encoding::Encode<fidl::encoding::BoundedString<2083>, D>,
395            T1: fidl::encoding::Encode<Context, D>,
396        > fidl::encoding::Encode<ResolverResolveWithContextRequest, D> for (T0, T1)
397    {
398        #[inline]
399        unsafe fn encode(
400            self,
401            encoder: &mut fidl::encoding::Encoder<'_, D>,
402            offset: usize,
403            depth: fidl::encoding::Depth,
404        ) -> fidl::Result<()> {
405            encoder.debug_check_bounds::<ResolverResolveWithContextRequest>(offset);
406            // Zero out padding regions. There's no need to apply masks
407            // because the unmasked parts will be overwritten by fields.
408            // Write the fields.
409            self.0.encode(encoder, offset + 0, depth)?;
410            self.1.encode(encoder, offset + 16, depth)?;
411            Ok(())
412        }
413    }
414
415    impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Decode<Self, D>
416        for ResolverResolveWithContextRequest
417    {
418        #[inline(always)]
419        fn new_empty() -> Self {
420            Self {
421                component_url: fidl::new_empty!(fidl::encoding::BoundedString<2083>, D),
422                context: fidl::new_empty!(Context, D),
423            }
424        }
425
426        #[inline]
427        unsafe fn decode(
428            &mut self,
429            decoder: &mut fidl::encoding::Decoder<'_, D>,
430            offset: usize,
431            _depth: fidl::encoding::Depth,
432        ) -> fidl::Result<()> {
433            decoder.debug_check_bounds::<Self>(offset);
434            // Verify that padding bytes are zero.
435            fidl::decode!(
436                fidl::encoding::BoundedString<2083>,
437                D,
438                &mut self.component_url,
439                decoder,
440                offset + 0,
441                _depth
442            )?;
443            fidl::decode!(Context, D, &mut self.context, decoder, offset + 16, _depth)?;
444            Ok(())
445        }
446    }
447}
fidl_fuchsia_component_resolution_common/fidl_fuchsia_component_resolution_common.rs

fidl_fuchsia_component_resolution_common/
fidl_fuchsia_component_resolution_common.rs
