Trait Encoding

pub trait Encoding {
    // Required methods
    fn extend_ssh_string(&mut self, s: &[u8]);
    fn extend_ssh_string_blank(&mut self, s: usize) -> &mut [u8] ;
    fn extend_ssh_mpint(&mut self, s: &[u8]);
    fn extend_list<'a, I: Iterator<Item = &'a [u8]>>(&mut self, list: I);
    fn extend_u32(&mut self, u: u32);
    fn write_empty_list(&mut self);
    fn write_len(&mut self);

    // Provided method
    fn extend_usize(&mut self, u: usize) { ... }
}

Encode in the SSH format.

Required Methods

fn extend_ssh_string(&mut self, s: &[u8])

Push an SSH-encoded string to self.

fn extend_ssh_string_blank(&mut self, s: usize) -> &mut [u8]

Push an SSH-encoded blank string of length s to self.

fn extend_ssh_mpint(&mut self, s: &[u8])

Push an SSH-encoded multiple-precision integer.

fn extend_list<'a, I: Iterator<Item = &'a [u8]>>(&mut self, list: I)

Push an SSH-encoded list.

fn extend_u32(&mut self, u: u32)

Push an SSH-encoded unsigned 32-bit integer.

fn write_empty_list(&mut self)

Push an SSH-encoded empty list.

fn write_len(&mut self)

Write the buffer length at the beginning of the buffer.

Provided Methods

fn extend_usize(&mut self, u: usize)

Push a usize as an SSH-encoded unsiged 32-bit integer. May panic if the argument is greater than u32::MAX. This is a convience method, to spare callers casting or converting usize to u32. If callers end up in a situation where they need to push a 32-bit unisgned integer, but the value they would like to push does not fit 32 bits, then the implementation will not comply with the SSH format anyway.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Encoding for Vec<u8>

fn extend_ssh_string(&mut self, s: &[u8])

fn extend_ssh_string_blank(&mut self, len: usize) -> &mut [u8]

fn extend_ssh_mpint(&mut self, s: &[u8])

fn extend_u32(&mut self, s: u32)

fn extend_list<'a, I: Iterator<Item = &'a [u8]>>(&mut self, list: I)

fn write_empty_list(&mut self)

fn write_len(&mut self)

Implementors

impl Encoding for Buffer