Struct distant_core::SessionInfoFile

pub struct SessionInfoFile { /* fields omitted */ }

Provides operations related to working with a session that is disk-based

Implementations

impl SessionInfoFile

pub fn new(path: impl Into<PathBuf>, session: SessionInfo) -> Self

Creates a new inmemory pointer to a session and its file

pub fn as_path(&self) -> &Path

Returns a reference to the path to the session file

pub fn as_session(&self) -> &SessionInfo

Returns a reference to the session

pub async fn save(&self) -> Result<()>

Saves a session by overwriting its current

pub async fn save_to(&self, path: impl AsRef<Path>, all: bool) -> Result<()>

Saves a session to to a file at the specified path

If all is true, will create all directories leading up to file’s location

pub async fn load_from(path: impl AsRef<Path>) -> Result<Self>

Loads a session from a file at the specified path

Methods from Deref<Target = SessionInfo>

pub async fn to_ip_addr(&self) -> Result<IpAddr>

Returns the ip address associated with the session based on the host

pub async fn to_socket_addr(&self) -> Result<SocketAddr>

Returns socket address associated with the session

pub fn to_unprotected_string(&self) -> String

Converts to unprotected string that exposes the auth key in the form of DISTANT DATA <host> <port> <auth key>

Trait Implementations

impl AsRef<Path> for SessionInfoFile

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<SessionInfo> for SessionInfoFile

fn as_ref(&self) -> &SessionInfo

Performs the conversion.

impl Deref for SessionInfoFile

type Target = SessionInfo

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<SessionInfoFile> for SessionInfo

fn from(sf: SessionInfoFile) -> Self

Performs the conversion.