Skip to main content

BriefcaseClient

Struct BriefcaseClient 

Source
pub struct BriefcaseClient { /* private fields */ }
Expand description

Authenticated client for the Briefcase AI platform.

Created via BriefcaseClient::new or BriefcaseClient::with_config, which validate the API key against the server before returning.

Implementations§

Source§

impl BriefcaseClient

Source

pub async fn new(api_key: &str, server_url: &str) -> Result<Self, ClientError>

Create a new client, validating the API key against the server.

Uses default configuration (30s timeout, 1h cache TTL, 3 retries).

Source

pub async fn with_config( api_key: &str, server_url: &str, config: ClientConfig, ) -> Result<Self, ClientError>

Create a new client with custom configuration.

Source

pub fn client_id(&self) -> &str

The authenticated client ID.

Source

pub fn permissions(&self) -> &[String]

Granted permissions.

Source

pub fn has_permission(&self, perm: &str) -> bool

Check whether this client has a specific permission.

Source

pub async fn revalidate(&self) -> Result<ValidatedClient, ClientError>

Re-validate the API key, using the cache if still fresh.

Source

pub fn invalidate_cache(&self)

Explicitly invalidate the validation cache.

Source

pub fn with_storage(self, storage: Arc<dyn StorageBackend>) -> Self

Bind a storage backend for delegated operations.

Source

pub async fn save_decision( &self, decision: &DecisionSnapshot, ) -> Result<String, ClientError>

Save a decision (requires “write” permission and a bound storage backend).

Source

pub async fn load_decision( &self, decision_id: &str, ) -> Result<DecisionSnapshot, ClientError>

Load a decision by ID (requires “read” permission and a bound storage backend).

Source

pub async fn query( &self, query: SnapshotQuery, ) -> Result<Vec<Snapshot>, ClientError>

Query snapshots (requires “read” permission and a bound storage backend).

Source

pub async fn delete(&self, id: &str) -> Result<bool, ClientError>

Delete a snapshot (requires “delete” permission and a bound storage backend).

Trait Implementations§

Source§

impl Debug for BriefcaseClient

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more