Trait WireFormat 

pub trait WireFormat: Send {
    // Required methods
    fn byte_size(&self) -> u32;
    fn encode<W: Write>(&self, writer: &mut W) -> Result<()>
       where Self: Sized;
    fn decode<R: Read>(reader: &mut R) -> Result<Self>
       where Self: Sized;
}

A type that can be encoded on the wire using the 9P protocol.

Required Methods

fn byte_size(&self) -> u32

Returns the number of bytes necessary to fully encode self.

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

Encodes self into writer.

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

Decodes Self from reader.

Implementations on Foreign Types

impl WireFormat for SocketAddr

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

impl WireFormat for bool

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for f32

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for f64

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for i16

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for i32

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for i64

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for i128

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for isize

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for u8

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for u16

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for u32

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for u64

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for u128

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for ()

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, _writer: &mut W) -> Result<()>

fn decode<R: Read>(_reader: &mut R) -> Result<Self>

impl WireFormat for usize

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for String

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for Ipv4Addr

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for Ipv6Addr

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for SocketAddrV4

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for SocketAddrV6

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl WireFormat for SystemTime

Implement WireFormat for SystemTime, must be used with care as it can lead to overflow errors on Windows.

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

impl WireFormat for Url

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

impl WireFormat for LabeledSpan

r[impl jetstream.miette.wireformat.labeled_span] LabeledSpan is encoded as:

• label: Option<String>
• span: SourceSpan (offset + length as usize)
• primary: bool

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

impl WireFormat for MietteDiagnostic

r[impl jetstream.miette.wireformat.miette_diagnostic] MietteDiagnostic is encoded as:

• message: String
• code: Option<String>
• severity: Option<Severity>
• help: Option<String>
• url: Option<String>
• labels: Option<Vec<LabeledSpan>>

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

impl WireFormat for Severity

r[impl jetstream.miette.wireformat.severity] Severity is encoded as a single byte:

• 0: Advice
• 1: Warning
• 2: Error

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

impl WireFormat for SourceOffset

r[impl jetstream.miette.wireformat.source_offset]

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

impl WireFormat for SourceSpan

r[impl jetstream.miette.wireformat.source_span] SourceSpan is encoded as offset (usize) followed by length (usize).

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

impl<K: WireFormat + Send + Sync + Ord, V: WireFormat + Send + Sync> WireFormat for BTreeMap<K, V>

Available on crate feature std only.

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

impl<T> WireFormat for Option<T>

where T: WireFormat,

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl<T: WireFormat> WireFormat for Box<T>

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

impl<T: WireFormat> WireFormat for Vec<T>

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

fn decode<R: Read>(reader: &mut R) -> Result<Self>

impl<T: WireFormat> WireFormat for PhantomData<T>

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, _writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(_reader: &mut R) -> Result<Self>

where Self: Sized,

impl<V: WireFormat + Send + Sync + Ord> WireFormat for BinaryHeap<V>

Available on crate feature std only.

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

impl<V: WireFormat + Send + Sync + Ord> WireFormat for BTreeSet<V>

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

impl<V: WireFormat + Send + Sync + Ord> WireFormat for VecDeque<V>

fn byte_size(&self) -> u32

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

Implementors

impl WireFormat for Data

impl WireFormat for P9String

impl<T, I> WireFormat for Wrapped<T, I>

where T: Send + AsRef<I>, I: WireFormat + Into<T>,

Available on non-WebAssembly only.