Struct Agent

Source
pub struct Agent<M>
where M: SessionManager + Send + Sync,
{ pub api: Service<Wrapper<M>>, /* private fields */ }
Available on crate feature agent only.
Expand description

A wrapper around a session manager and a client service.

An agent provides the following utilities:

  • AT Protocol labelers configuration utilities
  • AT Protocol proxy configuration utilities
  • Cloning utilities (if the session manager implements CloneWithProxy)

§Example

use atrium_api::agent::atp_agent::{store::MemorySessionStore, CredentialSession};
use atrium_api::agent::Agent;
use atrium_xrpc_client::reqwest::ReqwestClient;

let session = CredentialSession::new(
    ReqwestClient::new("https://bsky.social"),
    MemorySessionStore::default(),
);
let agent = Agent::new(session);

Fields§

§api: Service<Wrapper<M>>

Implementations§

Source§

impl<M> Agent<M>
where M: SessionManager + Send + Sync,

Source

pub fn new(session_manager: M) -> Self

Creates a new agent with the given session manager.

Source

pub async fn did(&self) -> Option<Did>

Returns the DID of the current session.

Source§

impl<M> Agent<M>

Source

pub fn api_with_proxy( &self, did: Did, service_type: impl AsRef<str>, ) -> Service<Wrapper<M>>

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

Returns a new client service with the proxy header configured.

Trait Implementations§

Source§

impl<M> Configure for Agent<M>

Source§

fn configure_endpoint(&self, endpoint: String)

Set the current endpoint.
Source§

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

Configures the moderation services to be applied on requests.
Source§

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

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

Auto Trait Implementations§

§

impl<M> Freeze for Agent<M>

§

impl<M> RefUnwindSafe for Agent<M>
where M: RefUnwindSafe,

§

impl<M> Send for Agent<M>

§

impl<M> Sync for Agent<M>

§

impl<M> Unpin for Agent<M>

§

impl<M> UnwindSafe for Agent<M>
where M: RefUnwindSafe,

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, C> Cacheable<C> for T

Source§

fn cached(self, cache: C) -> Cached<T, C>

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<P, T> Throttleable<P> for T
where P: Default,

Source§

fn throttled(self) -> Throttled<T, P>

Source§

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

Source§

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>,

Source§

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.