#[repr(C)]
pub struct TransactionHeader { pub tx_id: u32, pub at_rest_flags: [u8; 2], pub dynamic_flags: u8, pub magic_number: u8, pub ordinal: u64, }
Expand description

Header for transactional FIDL messages

Fields§

§tx_id: u32

Transaction ID which identifies a request-response pair

§at_rest_flags: [u8; 2]

Flags set for this message. MUST NOT be validated by bindings. Usually temporarily during migrations.

§dynamic_flags: u8

Flags used for dynamically interpreting the request if it is unknown to the receiver.

§magic_number: u8

Magic number indicating the message’s wire format. Two sides with different magic numbers are incompatible with each other.

§ordinal: u64

Ordinal which identifies the FIDL method

Implementations§

source§

impl TransactionHeader

source

pub fn is_compatible(&self) -> bool

Returns whether the message containing this TransactionHeader is in a compatible wire format

source§

impl TransactionHeader

source

pub fn new(tx_id: u32, ordinal: u64, dynamic_flags: DynamicFlags) -> Self

Creates a new transaction header with the default encode context and magic number.

source

pub fn new_full( tx_id: u32, ordinal: u64, context: Context, dynamic_flags: DynamicFlags, magic_number: u8 ) -> Self

Creates a new transaction header with a specific context and magic number.

source

pub fn is_epitaph(&self) -> bool

Returns true if the header is for an epitaph message.

source

pub fn validate_wire_format(&self) -> Result<()>

Returns an error if this header has an incompatible wire format.

source

pub fn validate_request_tx_id(&self, method_type: MethodType) -> Result<()>

Returns an error if this request header has an incorrect transaction id for the given method type.

source

pub fn at_rest_flags(&self) -> AtRestFlags

Returns the header’s migration flags as a AtRestFlags value.

source

pub fn dynamic_flags(&self) -> DynamicFlags

Returns the header’s dynamic flags as a DynamicFlags value.

source

pub fn decoding_context(&self) -> Context

Returns the context to use for decoding the message body associated with this header. During migrations, this is dependent on self.flags() and controls dynamic behavior in the read path.

Trait Implementations§

source§

impl Clone for TransactionHeader

source§

fn clone(&self) -> TransactionHeader

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for TransactionHeader

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Decode<TransactionHeader> for TransactionHeader

source§

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.
source§

unsafe fn decode( &mut self, decoder: &mut Decoder<'_>, offset: usize, _depth: Depth ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self. Read more
source§

impl Encode<TransactionHeader> for &TransactionHeader

source§

unsafe fn encode( self, encoder: &mut Encoder<'_>, offset: usize, _depth: Depth ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl PartialEq<TransactionHeader> for TransactionHeader

source§

fn eq(&self, other: &TransactionHeader) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl TypeMarker for TransactionHeader

§

type Owned = TransactionHeader

The owned Rust type which this FIDL type decodes into.
source§

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.
source§

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.
source§

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy. Read more
source§

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.
source§

impl ValueTypeMarker for TransactionHeader

§

type Borrowed<'a> = &'a TransactionHeader

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases: Read more
source§

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.
source§

impl Copy for TransactionHeader

source§

impl Eq for TransactionHeader

source§

impl StructuralEq for TransactionHeader

source§

impl StructuralPartialEq for TransactionHeader

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Encode<Ambiguous1> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> Encode<Ambiguous2> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<E> ErrorType for Ewhere E: ValueTypeMarker<Owned = E> + Decode<E>,

§

type Marker = E

The marker type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more