Struct Format 

pub struct Format(pub Cow<'static, str>);

A hint about the wire format of raw bytes.

Format is used to guide codecs when parsing Record::Raw bytes into Value, or when serializing Value back to bytes.

This uses MIME-type-like strings for familiarity, but you can use any string that your codecs understand.

Tuple Fields

0: Cow<'static, str>

Implementations

impl Format

pub const JSON: Format

JSON format (application/json)

pub const VALUE_JSON: Format

StructFS Value v1 tagged JSON (proposed media identifier).

pub const PROTOBUF: Format

Protocol Buffers (application/protobuf)

pub const MSGPACK: Format

MessagePack (application/msgpack)

pub const CBOR: Format

CBOR (application/cbor)

pub const FLEXBUFFERS: Format

FlexBuffers (application/x-flexbuffers; no registered MIME type)

pub const OCTET_STREAM: Format

Opaque binary data (application/octet-stream)

pub const VALUE: Format

A parsed Value that was never serialized.

Used when a Record contains a Value that hasn’t been through a codec.

pub const fn from_static(s: &'static str) -> Format

Create a format from a static string.

pub fn new(s: impl Into<String>) -> Format

Create a format from an owned string.

pub fn as_str(&self) -> &str

Get the format string.

pub fn is_json(&self) -> bool

Check if this is JSON format.

pub fn is_protobuf(&self) -> bool

Check if this is protobuf format.

pub fn is_value(&self) -> bool

Check if this is the VALUE format (parsed, never serialized).

Trait Implementations

impl AsRef<str> for Format

fn as_ref(&self) -> &str

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

impl Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Format

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Format

fn deserialize<D>( deserializer: D, ) -> Result<Format, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Format

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

Formats the value using the given formatter.

impl Eq for Format

impl From<&'static str> for Format

fn from(s: &'static str) -> Format

Converts to this type from the input type.

impl From<String> for Format

fn from(s: String) -> Format

Converts to this type from the input type.

impl Hash for Format

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

where __H: Hasher,

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 PartialEq for Format

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Format

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Format