Skip to main content

ReaderRequest

Struct ReaderRequest 

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

Request for POST /reader.

Implementations§

Source§

impl ReaderRequest

Source

pub fn new(url: impl Into<String>) -> Self

Create a reader request for the required URL.

Source

pub fn with_timeout_seconds(self, timeout: u64) -> Self

Set the upstream request timeout in seconds.

Source

pub fn with_cache_disabled(self, disabled: bool) -> Self

Configure cache bypass.

Source

pub fn with_return_format(self, format: impl Into<String>) -> Self

Set the requested output format, such as markdown or text.

Source

pub fn with_retained_images(self, retain: bool) -> Self

Configure whether images remain in the parsed content.

Source

pub fn with_gfm_disabled(self, disabled: bool) -> Self

Configure GitHub-Flavored Markdown conversion.

Source

pub fn with_image_data_urls(self, keep: bool) -> Self

Configure whether image data URLs are preserved.

Source

pub fn with_image_summaries(self, enabled: bool) -> Self

Configure image summaries.

Configure link summaries.

Source

pub fn url(&self) -> &str

Borrow the source URL.

Source

pub const fn timeout_seconds(&self) -> Option<u64>

Return the configured timeout in seconds.

Source

pub fn return_format(&self) -> Option<&str>

Borrow the requested return format.

Source

pub const fn cache_disabled(&self) -> Option<bool>

Return whether cache bypass was configured.

Source

pub const fn retained_images(&self) -> Option<bool>

Return whether parsed images are retained.

Source

pub const fn gfm_disabled(&self) -> Option<bool>

Return whether GitHub-Flavored Markdown is disabled.

Source

pub const fn keeps_image_data_urls(&self) -> Option<bool>

Return whether image data URLs are preserved.

Source

pub const fn image_summaries_enabled(&self) -> Option<bool>

Return whether image summaries are requested.

Return whether link summaries are requested.

Source

pub fn validate(&self) -> ZaiResult<()>

Validate the required URL string.

Source

pub async fn send_via(&self, client: &ZaiClient) -> ZaiResult<ReaderResponse>

Validate, send, and decode a reader response.

Trait Implementations§

Source§

impl Clone for ReaderRequest

Source§

fn clone(&self) -> ReaderRequest

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 ReaderRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Serialize for ReaderRequest

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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