Struct atrium_api::agent::AtpAgent

source ·
pub struct AtpAgent<S, T>
where S: SessionStore + Send + Sync, T: XrpcClient + Send + Sync,
{ pub api: Service<Client<S, T>>, /* private fields */ }
Available on crate feature agent only.
Expand description

An ATP “Agent”. Manages session token lifecycles and provides convenience methods.

Fields§

§api: Service<Client<S, T>>

Implementations§

source§

impl<S, T> AtpAgent<S, T>
where S: SessionStore + Send + Sync, T: XrpcClient + Send + Sync,

source

pub fn new(xrpc: T, store: S) -> Self

Create a new agent.

source

pub async fn login( &self, identifier: impl AsRef<str>, password: impl AsRef<str>, ) -> Result<Session, Error<Error>>

Start a new session with this agent.

source

pub async fn resume_session(&self, session: Session) -> Result<(), Error<Error>>

Resume a pre-existing session with this agent.

source

pub fn configure_endpoint(&self, endpoint: String)

Set the current endpoint.

source

pub fn configure_labelers_header(&self, labeler_dids: Option<Vec<(Did, bool)>>)

Configures the moderation services to be applied on requests.

source

pub fn configure_proxy_header(&self, did: Did, service_type: impl AsRef<str>)

Configures the atproto-proxy header to be applied on requests.

source

pub fn api_with_proxy( &self, did: Did, service_type: impl AsRef<str>, ) -> Service<Client<S, T>>

Configures the atproto-proxy header to be applied on requests.

Returns a new client service with the proxy header configured.

source

pub async fn get_session(&self) -> Option<Session>

Get the current session.

source

pub async fn get_endpoint(&self) -> String

Get the current endpoint.

source

pub async fn get_labelers_header(&self) -> Option<Vec<String>>

Get the current labelers header.

source

pub async fn get_proxy_header(&self) -> Option<String>

Get the current proxy header.

Auto Trait Implementations§

§

impl<S, T> Freeze for AtpAgent<S, T>

§

impl<S, T> !RefUnwindSafe for AtpAgent<S, T>

§

impl<S, T> Send for AtpAgent<S, T>

§

impl<S, T> Sync for AtpAgent<S, T>

§

impl<S, T> Unpin for AtpAgent<S, T>

§

impl<S, T> !UnwindSafe for AtpAgent<S, T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.