Struct Comment 

pub struct Comment(/* private fields */);

Available on crate feature alloc only.

SSH key comment (e.g. email address of owner)

Comments may be found in both the binary serialization of PrivateKey as well as the text serialization of PublicKey.

The binary serialization of PrivateKey stores the comment encoded as an RFC4251 string type which can contain arbitrary binary data and does not necessarily represent valid UTF-8. To support round trip encoding of such comments.

To support round-trip encoding of such comments, this type also supports arbitrary binary data.

Implementations

impl Comment

pub fn as_bytes(&self) -> &[u8]

Interpret the comment as raw binary data.

pub fn as_str(&self) -> Result<&str, Error>

Interpret the comment as a UTF-8 string.

Errors

Returns Error::CharacterEncoding in the event the underlying bytes cannot be interpreted as valid UTF-8.

pub fn as_str_lossy(&self) -> &str

Interpret the comment as a UTF-8 string.

This is the maximal prefix of the comment which can be interpreted as valid UTF-8.

pub fn is_empty(&self) -> bool

Is the comment empty?

pub fn len(&self) -> usize

Get the length of this comment in bytes.

Trait Implementations

impl AsRef<[u8]> for Comment

fn as_ref(&self) -> &[u8]

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

impl AsRef<str> for Comment

fn as_ref(&self) -> &str

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

impl Clone for Comment

fn clone(&self) -> Comment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Comment

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

Formats the value using the given formatter.

impl Decode for Comment

type Error = Error

Type returned in the event of a decoding error.

fn decode(reader: &mut impl Reader) -> Result<Self>

Attempt to decode a value of this type using the provided Reader.

impl Default for Comment

fn default() -> Comment

Returns the “default value” for a type.

impl Display for Comment

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

Formats the value using the given formatter.

impl Encode for Comment

fn encoded_len(&self) -> Result<usize, Error>

Get the length of this type encoded in bytes, prior to Base64 encoding.

fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>

Encode this value using the provided Writer.

fn encoded_len_prefixed(&self) -> Result<usize, Error>

Return the length of this type after encoding when prepended with a uint32 length prefix.

fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Error>

Encode this value, first prepending a uint32 length prefix set to Encode::encoded_len.

fn encode_vec(&self) -> Result<Vec<u8>, Error>

Encode this value, returning a Vec<u8> containing the encoded message.

impl From<&[u8]> for Comment

fn from(bytes: &[u8]) -> Comment

Converts to this type from the input type.

impl From<&str> for Comment

fn from(s: &str) -> Comment

Converts to this type from the input type.

impl From<Comment> for Vec<u8>

fn from(comment: Comment) -> Vec<u8>

Converts to this type from the input type.

impl From<String> for Comment

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Comment

fn from(vec: Vec<u8>) -> Self

Converts to this type from the input type.

impl FromStr for Comment

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Comment, Infallible>

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

impl Hash for Comment

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 Comment

fn cmp(&self, other: &Comment) -> 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 Comment

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

fn partial_cmp(&self, other: &Comment) -> 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 TryFrom<Comment> for String

type Error = Error

The type returned in the event of a conversion error.

fn try_from(comment: Comment) -> Result<String, Error>

Performs the conversion.

impl Eq for Comment

impl StructuralPartialEq for Comment