Struct Sync

pub struct Sync<'a> { /* private fields */ }

The Sync struct represents a message to synchronize the frontend and backend.

Available fields:

• mtype: Identifies the message as a Sync command. (value = 'S')

• mlen: Length of message contents in bytes, including self. (value = 4)

Implementations

impl<'a> Sync<'a>

pub const fn is_buffer(buf: &'a [u8]) -> bool

Checks the constant values for this struct to determine whether this message matches.

pub fn new(buf: &'a [u8]) -> Result<Self, ParseError>

Creates a new instance of this struct from a given buffer.

pub fn mtype(&self) -> u8

Identifies the message as a Sync command.

pub fn mlen(&self) -> Length

Length of message contents in bytes, including self.

pub fn to_vec(self) -> Vec<u8>

Trait Implementations

impl AsRef<[u8]> for Sync<'_>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for Sync<'a>

fn clone(&self) -> Sync<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> DataType for Sync<'a>

const META: StructFieldMeta

type BuilderForStruct<'unused> = SyncBuilder<'a>

type BuilderForEncode = SyncBuilder<'a>

Always a reference

type DecodeLifetime<'__next_lifetime> = Sync<'__next_lifetime>

fn decode<'__next_lifetime>( buf: &mut &'__next_lifetime [u8], ) -> Result<Self::DecodeLifetime<'__next_lifetime>, ParseError>

fn encode<'__buffer_lifetime, '__value_lifetime>( buf: &mut BufWriter<'__buffer_lifetime>, value: &'__value_lifetime Self::BuilderForEncode, )

fn encode_usize<'a>(buf: &mut BufWriter<'a>, value: usize)

fn decode_usize<'a>(buf: &mut &'a [u8]) -> Result<usize, ParseError>

impl Debug for Sync<'_>

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

Formats the value using the given formatter.

impl<'a> Default for Sync<'a>

fn default() -> Sync<'a>

Returns the “default value” for a type.

impl PartialEq for Sync<'_>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> StructMeta for Sync<'a>

Implements a trait containing the fields of the struct, allowing us to compute some useful things.

const FIELDS: StructFields

type Struct<'__struct> = Sync<'__struct>

fn new<'__next_lifetime>( buf: &'__next_lifetime [u8], ) -> Result<Self::Struct<'__next_lifetime>, ParseError>

fn to_vec(&self) -> Vec<u8>

const FIELD_COUNT: usize = _

const IS_FIXED_SIZE: bool = _

const FIXED_SIZE: Option<usize> = _

const LENGTH_FIELD_INDEX: Option<usize> = _

const HAS_LENGTH_FIELD: bool = _

impl<'a> Copy for Sync<'a>

impl Eq for Sync<'_>

impl StructAttributeFieldCount<{<$name<'_> as $crate::prelude::StructMeta>::FIELD_COUNT}> for Sync<'_>

Implements a trait indicating that the struct has a field count.

impl StructAttributeFixedSize<{<$name<'_> as $crate::prelude::StructMeta>::IS_FIXED_SIZE}> for Sync<'_>

Implements a trait indicating that the struct has a fixed size. This needs to be a trait-generic rather than and associated constant for us to use elsewhere.

impl StructAttributeHasLengthField<{<$name<'_> as $crate::prelude::StructMeta>::HAS_LENGTH_FIELD}> for Sync<'_>

Implements a trait indicating that the struct has a length field.