fidl_fuchsia_testing_harness_common/
fidl_fuchsia_testing_harness_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/// The maximum number of characters allowed in a FIDL protocol name.
12/// This is set to the maximum length of filesystem node name because
13/// we generally use the filesystem for protocol discovery.
14pub const MAX_PROTOCOL_LEN: u64 = fidl_fuchsia_io::MAX_NAME_LENGTH as u64;
15
16/// Fuchsia test harness operation error type.
17///
18/// A harness is responsible for maintaining the state for a particular test run.
19/// This type is returned when an operation fails.
20#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
21pub enum OperationError {
22    /// The requested operation is invalid.
23    ///
24    /// This is returned when a test case asked the harness to do
25    /// something incompatible with the harness' current state. This
26    /// error signifies a bug in the test code itself.
27    ///
28    /// Returning this value MUST fail the corresponding test.
29    ///
30    /// Example: Test asked for the size of a file before it was created.
31    Invalid,
32    /// The requested operation failed.
33    ///
34    /// This is returned when the test harness failed to complete
35    /// an operation, even though the current state should have permitted
36    /// the operation to work. This error signifies a bug in a
37    /// dependency of the harness.
38    ///
39    /// Returning this value MUST fail the corresponding test.
40    ///
41    /// Example: Test asked for the size of a file after it was
42    /// created, but the query failed.
43    Failed,
44    /// The requested operation is not supported by this harness.
45    ///
46    /// This is returned when the test harness does not support the
47    /// requested operation. This is not necessarily a fatal error, it
48    /// is used to signify that the harness has knowledge of what was
49    /// requested, but it does not implement the behavior.
50    ///
51    /// Returning this value MAY fail the corresponding test, but
52    /// it does not need to. This return value is useful to determine
53    /// compatibility with different feature sets or versions.
54    ///
55    /// Example: Test asked for the size of a file, but the ability
56    /// to check file sizes was removed in the previous component
57    /// version.
58    Unsupported,
59    #[doc(hidden)]
60    __SourceBreaking { unknown_ordinal: u32 },
61}
62
63/// Pattern that matches an unknown `OperationError` member.
64#[macro_export]
65macro_rules! OperationErrorUnknown {
66    () => {
67        _
68    };
69}
70
71impl OperationError {
72    #[inline]
73    pub fn from_primitive(prim: u32) -> Option<Self> {
74        match prim {
75            0 => Some(Self::Invalid),
76            1 => Some(Self::Failed),
77            2 => Some(Self::Unsupported),
78            _ => None,
79        }
80    }
81
82    #[inline]
83    pub fn from_primitive_allow_unknown(prim: u32) -> Self {
84        match prim {
85            0 => Self::Invalid,
86            1 => Self::Failed,
87            2 => Self::Unsupported,
88            unknown_ordinal => Self::__SourceBreaking { unknown_ordinal },
89        }
90    }
91
92    #[inline]
93    pub fn unknown() -> Self {
94        Self::__SourceBreaking { unknown_ordinal: 0xffffffff }
95    }
96
97    #[inline]
98    pub const fn into_primitive(self) -> u32 {
99        match self {
100            Self::Invalid => 0,
101            Self::Failed => 1,
102            Self::Unsupported => 2,
103            Self::__SourceBreaking { unknown_ordinal } => unknown_ordinal,
104        }
105    }
106
107    #[inline]
108    pub fn is_unknown(&self) -> bool {
109        match self {
110            Self::__SourceBreaking { unknown_ordinal: _ } => true,
111            _ => false,
112        }
113    }
114}
115
116mod internal {
117    use super::*;
118    unsafe impl fidl::encoding::TypeMarker for OperationError {
119        type Owned = Self;
120
121        #[inline(always)]
122        fn inline_align(_context: fidl::encoding::Context) -> usize {
123            std::mem::align_of::<u32>()
124        }
125
126        #[inline(always)]
127        fn inline_size(_context: fidl::encoding::Context) -> usize {
128            std::mem::size_of::<u32>()
129        }
130
131        #[inline(always)]
132        fn encode_is_copy() -> bool {
133            false
134        }
135
136        #[inline(always)]
137        fn decode_is_copy() -> bool {
138            false
139        }
140    }
141
142    impl fidl::encoding::ValueTypeMarker for OperationError {
143        type Borrowed<'a> = Self;
144        #[inline(always)]
145        fn borrow(value: &<Self as fidl::encoding::TypeMarker>::Owned) -> Self::Borrowed<'_> {
146            *value
147        }
148    }
149
150    unsafe impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Encode<Self, D> for OperationError {
151        #[inline]
152        unsafe fn encode(
153            self,
154            encoder: &mut fidl::encoding::Encoder<'_, D>,
155            offset: usize,
156            _depth: fidl::encoding::Depth,
157        ) -> fidl::Result<()> {
158            encoder.debug_check_bounds::<Self>(offset);
159            encoder.write_num(self.into_primitive(), offset);
160            Ok(())
161        }
162    }
163
164    impl<D: fidl::encoding::ResourceDialect> fidl::encoding::Decode<Self, D> for OperationError {
165        #[inline(always)]
166        fn new_empty() -> Self {
167            Self::unknown()
168        }
169
170        #[inline]
171        unsafe fn decode(
172            &mut self,
173            decoder: &mut fidl::encoding::Decoder<'_, D>,
174            offset: usize,
175            _depth: fidl::encoding::Depth,
176        ) -> fidl::Result<()> {
177            decoder.debug_check_bounds::<Self>(offset);
178            let prim = decoder.read_num::<u32>(offset);
179
180            *self = Self::from_primitive_allow_unknown(prim);
181            Ok(())
182        }
183    }
184}
fidl_fuchsia_testing_harness_common/fidl_fuchsia_testing_harness_common.rs

fidl_fuchsia_testing_harness_common/
fidl_fuchsia_testing_harness_common.rs
