Struct Describe 

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

The Describe struct represents a message to describe a prepared statement or portal.

Available fields:

• mtype: Identifies the message as a Describe command. (value = 'D')

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

• dtype: ‘S’ to describe a prepared statement; ‘P’ to describe a portal.

• name: The name of the prepared statement or portal.

Implementations

impl<'a> Describe<'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 Describe command.

pub fn mlen(&self) -> Length

Length of message contents in bytes, including self.

pub fn dtype(&self) -> DescribeType

‘S’ to describe a prepared statement; ‘P’ to describe a portal.

pub fn name(&self) -> ZTString<'a>

The name of the prepared statement or portal.

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

Trait Implementations

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

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

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

impl<'a> Clone for Describe<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> DataType for Describe<'a>

const META: StructFieldMeta

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

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

impl Debug for Describe<'_>

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

Formats the value using the given formatter.

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

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

impl<'a> Default for Describe<'a>

fn default() -> Describe<'a>

Returns the “default value” for a type.

impl<DTYPE, NAME> EncoderFor<Describe<'static>> for &DescribeBuilder<DTYPE, NAME>

where DTYPE: EncoderFor<DescribeType>, NAME: EncoderFor<ZTString<'static>>,

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

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

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

impl<DTYPE, NAME> EncoderFor<Describe<'static>> for DescribeBuilder<DTYPE, NAME>

where DTYPE: EncoderFor<DescribeType>, NAME: EncoderFor<ZTString<'static>>,

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

impl PartialEq for Describe<'_>

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

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

const FIELDS: StructFields

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

impl Eq for Describe<'_>

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

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

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

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

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