Struct UsernamePasswordResponse

pub struct UsernamePasswordResponse {
    pub version: UsernamePasswordSubnegotiationVersion,
    pub status: u8,
}

Response to the username-password request sent by the client.

he server verifies the supplied UNAME and PASSWD, and sends the following response:

+----+--------+
|VER | STATUS |
+----+--------+
| 1  |   1    |
+----+--------+

A STATUS field of X’00’ indicates success. If the server returns a `failure’ (STATUS value other than X’00’) status, it MUST close the connection.

Reference: https://datatracker.ietf.org/doc/html/rfc1929#section-2

Fields

version: UsernamePasswordSubnegotiationVersion

status: u8

Implementations

impl UsernamePasswordResponse

pub fn new_success() -> UsernamePasswordResponse

Create a new UsernamePasswordResponse to indicate success.

pub fn new_invalid_credentails() -> UsernamePasswordResponse

Create a new failure UsernamePasswordResponse to indicate the received credentials are partial or invalid otherwise.

pub fn new_user_not_found() -> UsernamePasswordResponse

Create a new failure UsernamePasswordResponse to indicate no user cound be found for the given credentials.

pub fn new_auth_system_unavailable() -> UsernamePasswordResponse

Create a new UsernamePasswordResponse to indicate the user couldn’t be authorized as the authorization used by the server is unavailable.

pub fn success(&self) -> bool

Indicates if the (auth) response from the server indicates success.

impl UsernamePasswordResponse

pub async fn read_from<R>( r: &mut R, ) -> Result<UsernamePasswordResponse, ProtocolError>

where R: AsyncRead + Unpin,

Read the server UsernamePasswordResponse, decoded from binary format as specified by RFC 1928 from the reader.

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

where W: AsyncWrite + Unpin,

Write the server UsernamePasswordResponse in binary format as specified by RFC 1928 into the writer.

pub fn write_to_buf<B>(&self, buf: &mut B)

where B: BufMut,

Write the server UsernamePasswordResponse in binary format as specified by RFC 1928 into the buffer.

Trait Implementations

impl Clone for UsernamePasswordResponse

fn clone(&self) -> UsernamePasswordResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsernamePasswordResponse

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

Formats the value using the given formatter.

impl PartialEq for UsernamePasswordResponse

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

impl StructuralPartialEq for UsernamePasswordResponse