#[non_exhaustive]pub struct SyncFrame {
pub msg_type: SyncMessageType,
pub body: Vec<u8>,
}Expand description
Wire frame: wraps a message type + serialized body.
Layout: [msg_type: 1B][length: 4B LE][body: N bytes]
Total header: 5 bytes.
#[non_exhaustive] — additional header fields (e.g. compression flag,
session token) may be added without breaking downstream consumers.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.msg_type: SyncMessageType§body: Vec<u8>Implementations§
Source§impl SyncFrame
impl SyncFrame
pub const HEADER_SIZE: usize = 5
Sourcepub fn from_bytes(data: &[u8]) -> Option<Self>
pub fn from_bytes(data: &[u8]) -> Option<Self>
Deserialize a frame from bytes.
Returns None if the data is too short or the message type is unknown.
Sourcepub fn new_msgpack<T: ToMessagePack>(
msg_type: SyncMessageType,
value: &T,
) -> Option<Self>
pub fn new_msgpack<T: ToMessagePack>( msg_type: SyncMessageType, value: &T, ) -> Option<Self>
Create a frame with a MessagePack-serialized body.
Sourcepub fn try_encode<T: ToMessagePack>(
msg_type: SyncMessageType,
value: &T,
) -> Option<Self>
pub fn try_encode<T: ToMessagePack>( msg_type: SyncMessageType, value: &T, ) -> Option<Self>
Try to encode a value into a SyncFrame body.
Returns None and logs an error on serialization failure — callers
should propagate via ?. The protocol must never ship a frame
whose body did not serialize successfully.
Sourcepub fn decode_body<T: FromMessagePackOwned>(&self) -> Option<T>
pub fn decode_body<T: FromMessagePackOwned>(&self) -> Option<T>
Deserialize the body from MessagePack.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for SyncFrame
impl RefUnwindSafe for SyncFrame
impl Send for SyncFrame
impl Sync for SyncFrame
impl Unpin for SyncFrame
impl UnsafeUnpin for SyncFrame
impl UnwindSafe for SyncFrame
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Returns the layout of the type.
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Returns whether the given value has been niched. Read more
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
Writes data to
out indicating that a T is niched.Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.