warg_client::api

Struct Client

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

Represents a Warg API client for communicating with a Warg registry server.

Implementations§

Source§

impl Client

Source

pub fn new( url: impl IntoUrl, auth_token: Option<Secret<String>>, ) -> Result<Self>

Creates a new API client with the given URL.

Source

pub fn auth_token(&self) -> &Option<Secret<String>>

Gets auth token

Source

pub fn url(&self) -> &RegistryUrl

Gets the URL of the API client.

Source

pub async fn well_known_config( &self, ) -> Result<Option<RegistryUrl>, ClientError>

Gets the .well-known configuration registry URL.

Source

pub async fn latest_checkpoint( &self, registry_domain: Option<&RegistryDomain>, ) -> Result<SerdeEnvelope<TimestampedCheckpoint>, ClientError>

Gets the latest checkpoint from the registry.

Source

pub async fn verify_checkpoint( &self, registry_domain: Option<&RegistryDomain>, request: SerdeEnvelope<TimestampedCheckpoint>, ) -> Result<CheckpointVerificationResponse, ClientError>

Verify checkpoint of the registry.

Source

pub async fn fetch_logs( &self, registry_domain: Option<&RegistryDomain>, request: FetchLogsRequest<'_>, ) -> Result<FetchLogsResponse, ClientError>

Fetches package log entries from the registry.

Source

pub async fn fetch_package_names( &self, registry_domain: Option<&RegistryDomain>, request: FetchPackageNamesRequest<'_>, ) -> Result<FetchPackageNamesResponse, ClientError>

Fetches package names from the registry.

Source

pub async fn ledger_sources( &self, registry_domain: Option<&RegistryDomain>, ) -> Result<LedgerSourcesResponse, ClientError>

Gets ledger sources from the registry.

Source

pub async fn publish_package_record( &self, registry_domain: Option<&RegistryDomain>, log_id: &LogId, request: PublishRecordRequest<'_>, ) -> Result<PackageRecord, ClientError>

Publish a new record to a package log.

Source

pub async fn get_package_record( &self, registry_domain: Option<&RegistryDomain>, log_id: &LogId, record_id: &RecordId, ) -> Result<PackageRecord, ClientError>

Gets a package record from the registry.

Source

pub async fn content_sources( &self, registry_domain: Option<&RegistryDomain>, digest: &AnyHash, ) -> Result<ContentSourcesResponse, ClientError>

Gets a content sources from the registry.

Source

pub async fn download_content( &self, registry_domain: Option<&RegistryDomain>, digest: &AnyHash, ) -> Result<impl Stream<Item = Result<Bytes>>, ClientError>

Downloads the content associated with a given record.

Source

pub fn set_warg_registry(&mut self, registry: Option<RegistryDomain>)

Set warg-registry header value

Source

pub async fn prove_inclusion( &self, registry_domain: Option<&RegistryDomain>, request: InclusionRequest, checkpoint: &Checkpoint, leafs: &[LogLeaf], ) -> Result<(), ClientError>

Proves the inclusion of the given package log heads in the registry.

Source

pub async fn prove_log_consistency( &self, registry_domain: Option<&RegistryDomain>, request: ConsistencyRequest, from_log_root: Cow<'_, AnyHash>, to_log_root: Cow<'_, AnyHash>, ) -> Result<(), ClientError>

Proves consistency between two log roots.

Source

pub async fn upload_content( &self, method: &str, url: &str, headers: &IndexMap<String, String>, content: impl Into<Body>, ) -> Result<(), ClientError>

Uploads package content to the registry.

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,