Skip to main content

Client

Struct Client 

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

A handle on one mdcast-server. Cheap to clone — the underlying reqwest::Client is a shared connection pool.

Implementations§

Source§

impl Client

Source

pub async fn check(&self, bundle: &AssetBundle) -> Result<Vec<Digest>>

Which of the bundle’s assets the server does not hold yet. An empty result means a render with this bundle will not stall on a 409. Never fetches a digest-only entry’s bytes — only its stored digest.

Source

pub async fn upload( &self, bundle: &AssetBundle, digests: &[Digest], ) -> Result<()>

Upload the named digests from bundle. A digest nothing in the bundle hashes to is Error::UnknownDigest — the request is never sent half-formed.

Source

pub async fn preflight(&self, bundle: &AssetBundle) -> Result<Vec<Digest>>

The pessimistic strategy: ask what is missing, upload exactly that, and let the render that follows go straight through. Returns the digests it uploaded.

Source§

impl Client

Source

pub fn builder(base_url: impl Into<String>) -> ClientBuilder

Start building a client for the server at base_url (http://mdcast.internal:8080, with or without a trailing slash).

Source

pub fn base_url(&self) -> &str

The normalised base URL, without its trailing slash.

Source

pub async fn render( &self, request: RenderMarkdownRequest, bundle: &AssetBundle, ) -> Result<Artifact>

Render markdown, negotiating any assets the server is missing.

request.assets is filled from bundle when the caller left it empty, and verified against it otherwise.

Source

pub async fn render_template( &self, request: RenderTemplateRequest, bundle: &AssetBundle, ) -> Result<Artifact>

Render a typst template over structured data — same negotiation, same single retry.

Source

pub async fn capabilities(&self) -> Result<CapabilitiesResponse>

What this server can actually render right now — targets, template formats, and its upload size ceiling. Unauthenticated server-side (GET /v1/capabilities sits outside the bearer gate), so this is useful for feature-gating a UI before a render is ever attempted.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Self

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

Debug is written out rather than derived on both types: the token is a shared secret, and a derived impl would print it into whatever log or panic message formats the 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> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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