Enum FrameKind

pub enum FrameKind {
    Array,
    BlobString,
    SimpleString,
    SimpleError,
    Number,
    Null,
    Double,
    Boolean,
    BlobError,
    VerbatimString,
    Map,
    Set,
    Attribute,
    Push,
    Hello,
    BigNumber,
    ChunkedString,
    EndStream,
}

The type of frame without any associated data.

Variants

Array

BlobString

SimpleString

SimpleError

Number

Null

Double

Boolean

BlobError

VerbatimString

Map

Set

Attribute

Push

Hello

BigNumber

ChunkedString

EndStream

Implementations

impl FrameKind

pub fn is_aggregate_type(&self) -> bool

Whether or not the frame is an aggregate type (array, set, map).

pub fn is_streaming_type(&self) -> bool

Whether or not the frame is an aggregate type or blob string.

pub fn hash_prefix(&self) -> &'static str

A function used to differentiate data types that may have the same inner binary representation when hashing a Frame.

pub fn from_byte(d: u8) -> Option<FrameKind>

Attempt to detect the type of the frame from the first byte.

pub fn to_byte(&self) -> u8

Read the byte prefix for the associated frame type.

pub fn is_hello(&self) -> bool

Whether or not the frame type is for a HELLO frame.

HELLO is encoded differently than other frames so this is used to prevent panics in to_byte.

Trait Implementations

impl Clone for FrameKind

fn clone(&self) -> FrameKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameKind

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

Formats the value using the given formatter.

impl Hash for FrameKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FrameKind

fn cmp(&self, other: &FrameKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FrameKind

fn eq(&self, other: &FrameKind) -> 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 PartialOrd for FrameKind

fn partial_cmp(&self, other: &FrameKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for FrameKind

impl Eq for FrameKind

impl StructuralPartialEq for FrameKind