Struct ssh_packet::SshId

pub struct SshId {
    pub protoversion: String,
    pub softwareversion: String,
    pub comments: Option<String>,
}

The SSH identification string as defined in the SSH protocol.

The format must match the following pattern: SSH-<protoversion>-<softwareversion>[ <comments>].

see https://datatracker.ietf.org/doc/html/rfc4253#section-4.2.

Fields

protoversion: String

The SSH’s protocol version, should be 2.0 in our case.

softwareversion: String

A string identifying the software curently used, in example billsSSH_3.6.3q3.

comments: Option<String>

Optional comments with additionnal informations about the software.

Implementations

impl SshId

pub fn v2( softwareversion: impl Into<String>, comments: Option<impl Into<String>> ) -> Self

Convenience method to create an SSH-2.0 identifier string.

pub fn from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: BufRead,

Read an SshId, discarding any extra lines sent by the server from the provided reader.

pub async fn from_async_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: AsyncBufRead + Unpin,

Available on crate feature futures only.

Read an SshId, discarding any extra lines sent by the server from the provided asynchronous reader.

pub fn to_writer<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write,

Write the SshId to the provided writer.

pub async fn to_async_writer<W>(&self, writer: &mut W) -> Result<(), Error>

where W: AsyncWrite + Unpin,

Available on crate feature futures only.

Write the SshId to the provided asynchronous writer.

Trait Implementations

impl Clone for SshId

fn clone(&self) -> SshId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SshId

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

Formats the value using the given formatter.

impl Display for SshId

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

Formats the value using the given formatter.

impl FromStr for SshId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for SshId

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SshId

impl StructuralPartialEq for SshId