Struct DumpHeader

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

The DumpHeader struct represents a dump header message.

Available fields:

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

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

• attributes: Dump attributes.

• major_ver: Major version of EdgeDB.

• minor_ver: Minor version of EdgeDB.

• schema_ddl: Schema.

• types: Type identifiers.

• descriptors: Object descriptors.

Implementations

impl<'a> DumpHeader<'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 header.

pub fn mlen(&self) -> Length

Length of message contents in bytes, including self.

pub fn attributes(&self) -> Array<'a, i16, KeyValue<'a>>

Dump attributes.

pub fn major_ver(&self) -> i16

Major version of EdgeDB.

pub fn minor_ver(&self) -> i16

Minor version of EdgeDB.

pub fn schema_ddl(&self) -> LString<'a>

Schema.

pub fn types(&self) -> Array<'a, i32, DumpTypeInfo<'a>>

Type identifiers.

pub fn descriptors(&self) -> Array<'a, i32, DumpObjectDesc<'a>>

Object descriptors.

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

Trait Implementations

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

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

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

impl<'a> Clone for DumpHeader<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> DataType for DumpHeader<'a>

const META: StructFieldMeta

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

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

impl Debug for DumpHeader<'_>

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

Formats the value using the given formatter.

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

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

impl<'a> Default for DumpHeader<'a>

fn default() -> DumpHeader<'a>

Returns the “default value” for a type.

impl<ATTRIBUTES, MAJOR_VER, MINOR_VER, SCHEMA_DDL, TYPES, DESCRIPTORS> EncoderFor<DumpHeader<'static>> for &DumpHeaderBuilder<ATTRIBUTES, MAJOR_VER, MINOR_VER, SCHEMA_DDL, TYPES, DESCRIPTORS>

where ATTRIBUTES: EncoderFor<Array<'static, i16, KeyValue<'static>>>, MAJOR_VER: EncoderFor<i16>, MINOR_VER: EncoderFor<i16>, SCHEMA_DDL: EncoderFor<LString<'static>>, TYPES: EncoderFor<Array<'static, i32, DumpTypeInfo<'static>>>, DESCRIPTORS: EncoderFor<Array<'static, i32, DumpObjectDesc<'static>>>,

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

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

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

impl<ATTRIBUTES, MAJOR_VER, MINOR_VER, SCHEMA_DDL, TYPES, DESCRIPTORS> EncoderFor<DumpHeader<'static>> for DumpHeaderBuilder<ATTRIBUTES, MAJOR_VER, MINOR_VER, SCHEMA_DDL, TYPES, DESCRIPTORS>

where ATTRIBUTES: EncoderFor<Array<'static, i16, KeyValue<'static>>>, MAJOR_VER: EncoderFor<i16>, MINOR_VER: EncoderFor<i16>, SCHEMA_DDL: EncoderFor<LString<'static>>, TYPES: EncoderFor<Array<'static, i32, DumpTypeInfo<'static>>>, DESCRIPTORS: EncoderFor<Array<'static, i32, DumpObjectDesc<'static>>>,

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

impl PartialEq for DumpHeader<'_>

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 DumpHeader<'a>

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

const FIELDS: StructFields

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

impl Eq for DumpHeader<'_>

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

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

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

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

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