ftml_viewer_components::remote

Struct ServerConfig

Source 
pub struct ServerConfig {
    pub server_url: Mutex<String>,
    get_full_doc: Cache<(Option<DocumentURI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>), (DocumentURI, Vec<CSS>, String)>,
    get_fragment: Cache<(Option<URI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>, Option<String>, Option<String>, Option<String>, Option<URI>), (URI, Vec<CSS>, String)>,
    get_omdoc: Cache<(Option<URI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>, Option<String>, Option<String>, Option<String>), (Vec<CSS>, OMDoc)>,
    get_toc: Cache<(Option<DocumentURI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>), (Vec<CSS>, Vec<TOCElem>)>,
    get_los: Cache<(Option<SymbolURI>, Option<ArchiveId>, Option<String>, Option<String>, Option<String>, bool), Vec<(DocumentElementURI, LOKind)>>,
    get_notations: Cache<(Option<URI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>, Option<String>, Option<String>, Option<String>), Vec<(DocumentElementURI, Notation)>>,
    get_solution: Cache<(Option<URI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>, Option<String>, Option<String>, Option<String>), String>,
}

Fields§

§server_url: Mutex<String>
Available on crate feature csr only.
§get_full_doc: Cache<(Option<DocumentURI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>), (DocumentURI, Vec<CSS>, String)>§get_fragment: Cache<(Option<URI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>, Option<String>, Option<String>, Option<String>, Option<URI>), (URI, Vec<CSS>, String)>§get_omdoc: Cache<(Option<URI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>, Option<String>, Option<String>, Option<String>), (Vec<CSS>, OMDoc)>
Available on crate feature omdoc only.
§get_toc: Cache<(Option<DocumentURI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>), (Vec<CSS>, Vec<TOCElem>)>§get_los: Cache<(Option<SymbolURI>, Option<ArchiveId>, Option<String>, Option<String>, Option<String>, bool), Vec<(DocumentElementURI, LOKind)>>§get_notations: Cache<(Option<URI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>, Option<String>, Option<String>, Option<String>), Vec<(DocumentElementURI, Notation)>>
Available on crate feature omdoc only.
§get_solution: Cache<(Option<URI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>, Option<String>, Option<String>, Option<String>), String>

Implementations§

Source§

impl ServerConfig

Source

pub fn top_doc_url(&self, uri: &DocumentURI) -> String

Source

pub async fn inputref( &self, doc: DocumentURI, ) -> Result<(URI, Vec<CSS>, String), String>

§Errors
§Panics
Source

pub async fn paragraph( &self, doc: DocumentElementURI, ) -> Result<(URI, Vec<CSS>, String), String>

§Errors
§Panics
Source

pub async fn definition( &self, uri: SymbolURI, ) -> Result<(Vec<CSS>, String), String>

§Errors
§Panics
Source

pub async fn full_doc( &self, uri: DocumentURI, ) -> Result<(DocumentURI, Vec<CSS>, String), String>

§Errors
§Panics
Source

pub async fn get_toc( &self, uri: DocumentURI, ) -> Result<(Vec<CSS>, Vec<TOCElem>), String>

§Errors
§Panics
Source

pub async fn get_los( &self, uri: SymbolURI, problems: bool, ) -> Result<Vec<(DocumentElementURI, LOKind)>, String>

§Errors
§Panics
Source

pub async fn omdoc(&self, uri: URI) -> Result<(Vec<CSS>, OMDoc), String>

Available on crate feature omdoc only.
§Errors
§Panics
Source

pub async fn solution( &self, uri: DocumentElementURI, ) -> Result<Solutions, String>

§Errors
§Panics
Source

pub async fn notations( &self, uri: URI, ) -> Result<Vec<(DocumentElementURI, Notation)>, String>

Available on crate feature omdoc only.
§Errors
§Panics
Source

pub fn get_notation(&self, uri: &DocumentElementURI) -> Option<Notation>

Available on crate feature omdoc only.
Source

pub async fn present(&self, t: Term) -> Result<String, String>

Available on crate feature omdoc only.
Source

async fn load_notations(&self, uri: URI)

Available on crate feature omdoc and (crate features csr or hydrate) only.
Source

pub fn initialize( fragment: fn(Option<URI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>, Option<String>, Option<String>, Option<String>, Option<URI>) -> Pin<Box<dyn Future<Output = Result<(URI, Vec<CSS>, String), ServerFnError<String>>> + Send>>, full_doc: fn(Option<DocumentURI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>) -> Pin<Box<dyn Future<Output = Result<(DocumentURI, Vec<CSS>, String), ServerFnError<String>>> + Send>>, toc: fn(Option<DocumentURI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>) -> Pin<Box<dyn Future<Output = Result<(Vec<CSS>, Vec<TOCElem>), ServerFnError<String>>> + Send>>, omdoc: fn(Option<URI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>, Option<String>, Option<String>, Option<String>) -> Pin<Box<dyn Future<Output = Result<(Vec<CSS>, OMDoc), ServerFnError<String>>> + Send>>, los: fn(Option<SymbolURI>, Option<ArchiveId>, Option<String>, Option<String>, Option<String>, bool) -> Pin<Box<dyn Future<Output = Result<Vec<(DocumentElementURI, LOKind)>, ServerFnError<String>>> + Send>>, notations: fn(Option<URI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>, Option<String>, Option<String>, Option<String>) -> Pin<Box<dyn Future<Output = Result<Vec<(DocumentElementURI, Notation)>, ServerFnError<String>>> + Send>>, solutions: fn(Option<URI>, Option<String>, Option<ArchiveId>, Option<String>, Option<Language>, Option<String>, Option<String>, Option<String>, Option<String>) -> Pin<Box<dyn Future<Output = Result<String, ServerFnError<String>>> + Send>>, )

Available on crate features hydrate or ssr only.
Source§

impl ServerConfig

Source

async fn remote<T: for<'a> Deserialize<'a>>(url: String) -> Result<T, String>

Available on crate feature csr only.

Trait Implementations§

Source§

impl Default for ServerConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
§

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
§

impl<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
§

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
§

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
§

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
§

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
§

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
§

impl<T> Instrument for T

§

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

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

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, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
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
§

impl<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
§

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
§

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
§

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
§

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
§

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<T> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Metadata = ()

The type for metadata in pointers and references to Self.
§

impl<T> PolicyExt for T
where T: ?Sized,

§

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
§

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
§

impl<T> SerializableKey for T

§

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more
§

impl<T> StorageAccess<T> for T

§

fn as_borrowed(&self) -> &T

Borrows the value.
§

fn into_taken(self) -> T

Takes the value.
Source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. 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, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

§

impl<T> Fruit for T
where T: Send + Downcast,