Struct Dump3

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

The Dump3 struct represents a dump message from the client.

Available fields:

• mtype: Identifies the message as dump. (value = '>')

• mlen: Length of message contents in bytes, including self.

• annotations: Message annotations.

• flags: A bit mask of dump options.

Implementations

impl<'a> Dump3<'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 dump.

pub fn mlen(&self) -> Length

Length of message contents in bytes, including self.

pub fn annotations(&self) -> Array<'a, i16, Annotation<'a>>

Message annotations.

pub fn flags(&self) -> u64

A bit mask of dump options.

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

Trait Implementations

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

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

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

impl<'a> Clone for Dump3<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> DataType for Dump3<'a>

const META: StructFieldMeta

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

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

impl Debug for Dump3<'_>

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

Formats the value using the given formatter.

impl<'a> DecoderFor<'a, Dump3<'a>> for Dump3<'a>

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

impl<'a> Default for Dump3<'a>

fn default() -> Dump3<'a>

Returns the “default value” for a type.

impl<ANNOTATIONS, FLAGS> EncoderFor<Dump3<'static>> for &Dump3Builder<ANNOTATIONS, FLAGS>

where ANNOTATIONS: EncoderFor<Array<'static, i16, Annotation<'static>>>, FLAGS: EncoderFor<u64>,

fn encode_for(&self, buf: &mut BufWriter<'_>)

impl<'a> EncoderFor<Dump3<'static>> for Dump3<'a>

fn encode_for(&self, buf: &mut BufWriter<'_>)

impl<ANNOTATIONS, FLAGS> EncoderFor<Dump3<'static>> for Dump3Builder<ANNOTATIONS, FLAGS>

where ANNOTATIONS: EncoderFor<Array<'static, i16, Annotation<'static>>>, FLAGS: EncoderFor<u64>,

fn encode_for(&self, buf: &mut BufWriter<'_>)

impl PartialEq for Dump3<'_>

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

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

const 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 Dump3<'a>

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

const FIELDS: StructFields

type Struct<'__struct> = Dump3<'__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 Dump3<'a>

impl Eq for Dump3<'_>

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

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

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

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 Dump3<'_>

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