Skip to main content

Client

Struct Client 

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

Client is the cleanlib-client HTTP transport handle. Cheap to clone; share across verbs in the same process.

Implementations§

Source§

impl Client

Source

pub fn from_config(config: &Config) -> Result<Self, CleanLibraryError>

Construct from a loaded Config. TLS required for non-localhost endpoints. Returns TlsRequired for http:// on remote hosts.

Source

pub fn new( endpoint: &str, api_key: Option<String>, ) -> Result<Self, CleanLibraryError>

Construct with explicit endpoint + api_key. Intended for integration tests + ad-hoc invocations (e.g., CLI --endpoint= flag future).

Source

pub async fn fetch_verdict( &self, ecosystem: &str, package: &str, version: &str, ) -> Result<Verdict, CleanLibraryError>

Fetch a single verdict per App Rev 4 §9.3 + GET /v1/customer/verdicts/{ecosystem}/{package}/{version}.

Source

pub async fn policy_preview( &self, req: &PolicyPreviewRequest, ) -> Result<PolicyPreviewResponse, CleanLibraryError>

Submit a packages + optional-policy request to POST /v1/customer/policy/preview. Used by cleanlib scan (no policy override; preview against active customer policy) and cleanlib policy preview (with explicit policy override).

Source

pub async fn fetch_artifact( &self, ecosystem: &str, package: &str, version: &str, ) -> Result<Vec<u8>, CleanLibraryError>

Fetch the raw artifact bytes for (ecosystem, package, version) via App’s per-ecosystem registry proxy (App Rev 4 §5.4 + cycle-3 §C.8). Returns owned Vec<u8> — caller decides write target. Emits decision

  • reason headers to stderr for visibility (binary stdout stays clean).
Source

pub async fn fetch_artifact_stream<W>( &self, ecosystem: &str, package: &str, version: &str, writer: &mut W, ) -> Result<u64, CleanLibraryError>
where W: AsyncWrite + Unpin,

Streaming variant of Self::fetch_artifact — writes chunks to writer without buffering the full body in memory. Per Client Rev 2 amendment §9.4 cycle-4 §D.5 streaming substrate. Returns total bytes written. Decision + reason headers surface to stderr before stream.

Source

pub async fn audit( &self, since: Option<&str>, decision: Option<&str>, ecosystem: Option<&str>, ) -> Result<AuditResponse, CleanLibraryError>

Query customer audit log via GET /v1/customer/audit with optional filters. Caller passes already-validated filter values.

Source

pub async fn send( &self, method: Method, url: Url, ) -> Result<Response, CleanLibraryError>

Low-level: send a request with auth header. Used internally by verb methods; public for advanced consumers (future).

Source

pub fn base_url(&self) -> &Url

Expose the base URL for diagnostics + integration tests.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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: Sized + 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: Sized + 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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