Struct TextString 

pub struct TextString<'a>(pub &'a [u8]);

A text string that may be presented to a user or used for things such as a password, username, exec command, TCP hostname, etc.

The SSH protocol defines it to be UTF-8, though in some applications it could be treated as ASCII-only. Sunset treats it as an opaque &[u8], leaving interpretation to the application.

Note that SSH protocol identifiers in Packet are &str rather than TextString, and always defined as ASCII. For example "publickey", "ssh-ed25519".

Application API

Tuple Fields

0: &'a [u8]

Implementations

impl<'a> TextString<'a>

pub fn as_str(&self) -> Result<&'a str>

Returns the UTF-8 decoded string, using core::str::from_utf8

Don’t call this if you are avoiding including UTF-8 routines in the binary.

pub fn as_ascii(&self) -> Result<&'a str>

Trait Implementations

impl<'a> AsRef<[u8]> for TextString<'a>

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

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

impl<'a> Clone for TextString<'a>

fn clone(&self) -> TextString<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextString<'_>

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

Formats the value using the given formatter.

impl Display for TextString<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for TextString<'a>

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl<'a> Hash for TextString<'a>

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<'a> Ord for TextString<'a>

fn cmp(&self, other: &TextString<'a>) -> 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<'a> PartialEq for TextString<'a>

fn eq(&self, other: &TextString<'a>) -> 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<'a> PartialOrd for TextString<'a>

fn partial_cmp(&self, other: &TextString<'a>) -> 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<'de> SSHDecode<'de> for TextString<'de>

fn dec<S>(s: &mut S) -> WireResult<Self>

where S: SSHSource<'de>,

Decode data

impl SSHEncode for TextString<'_>

fn enc(&self, s: &mut dyn SSHSink) -> WireResult<()>

Encode data

impl<'a> Copy for TextString<'a>

impl<'a> Eq for TextString<'a>

impl<'a> StructuralPartialEq for TextString<'a>