Struct HostCandidate 

pub struct HostCandidate { /* private fields */ }

One completion candidate: the endpoint local data knows about. token() renders exactly what can be typed after ssh://; the constructor is pure and admissible() is judged by the address grammar alone.

Implementations

impl HostCandidate

pub fn new( host: String, user: Option<String>, port: Option<NonZeroU16>, origin: CandidateOrigin, ) -> Self

pub fn host(&self) -> &str

pub fn user(&self) -> Option<&str>

pub fn port(&self) -> Option<NonZeroU16>

pub fn origin(&self) -> CandidateOrigin

pub fn token(&self) -> String

The endpoint as typed into an ssh:// URI (user@host:port, IPv6 bracketed). Display spelling of identity data.

pub fn admissible(&self) -> bool

True when the one address grammar admits this endpoint. This is the only validity notion in the crate — there is no local re-implementation of hostname rules.

pub fn matches_typed(&self, typed: &str) -> Option<String>

The completed endpoint token for a typed prefix, or None when this candidate does not extend what the user typed. Typing a user wins over a configured one; typing past : must extend the candidate’s port, never reset it.

Trait Implementations

impl Clone for HostCandidate

fn clone(&self) -> HostCandidate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HostCandidate

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

Formats the value using the given formatter.

impl Eq for HostCandidate

impl PartialEq for HostCandidate

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HostCandidate