Skip to main content

Mounted

Struct Mounted 

Source
pub struct Mounted<'a> {
    pub schema: &'a ResourceSchema,
    pub base_path: &'a str,
}
Available on crate feature domain only.
Expand description

A resource schema paired with the path it is served under.

The base path is not a domain concept — the domain does not know it is being served over HTTP — so the router supplies it alongside the schema.

Fields§

§schema: &'a ResourceSchema§base_path: &'a str

Implementations§

Source§

impl<'a> Mounted<'a>

Source

pub fn new(schema: &'a ResourceSchema, base_path: &'a str) -> Self

Source

pub fn record(&self, id: &str) -> Record<'_, Self>

Start a resource object for id, in one step.

Mounted::new(&schema, "/api/v1/todos")
    .record("t_1")
    .attr("message", "buy milk")
    .rel("owner", "u_01H8X")
    .build()
```ignore

The self link for one resource.

Source

pub fn record_from(&self, record: &DomainRecord) -> Record<'_, Self>

Serialize an ash_domain::Record straight from the domain.

Two things are dropped from attributes, because JSON:API carries them elsewhere: the primary key, which becomes the envelope id, and every relationship’s source attribute — a foreign key belongs in linkage, not beside the data. Everything else is converted as-is.

Relationships are added afterwards, since a Record holds foreign keys rather than linkage:

ⓘ
mounted.record_from(&record).rel("owner", owner_id).build()
Source§

impl<'a> Mounted<'a>

Source

pub fn parse_create<R>( &self, document: &Value, ctx: &Context, ) -> Result<R, JsonApiError>

Read a create document into the resource’s own type.

The document is expected to have passed DocumentValidator already — shape, required members and linkage are its job. What remains here is the typed conversion, driven by the schema’s declared attribute types.

Source

pub fn parse_update<R>( &self, document: &Value, id: &str, ctx: &Context, ) -> Result<R, JsonApiError>

Read an update document into the resource’s own type.

Same as Mounted::parse_create, except the primary key comes from the URL: a PATCH addresses a row that already exists, and the id in the path is authoritative over anything the body says.

Source§

impl Mounted<'_>

Source

pub fn record_for_create( &self, document: &Value, ctx: &Context, ) -> Result<DomainRecord, JsonApiError>

A create document as a domain Record.

The document has already passed the validator, so what is left is the typed conversion the schema drives.

Source

pub fn record_for_update( &self, document: &Value, id: &str, ctx: &Context, ) -> Result<DomainRecord, JsonApiError>

An update document as a domain Record, with the path’s id.

A PATCH addresses a row that exists, so the URL’s id wins over anything the body carries.

Trait Implementations§

Source§

impl<'a> Clone for Mounted<'a>

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<'a> Copy for Mounted<'a>

Source§

impl<'a> Debug for Mounted<'a>

Source§

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

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

impl Schema for Mounted<'_>

Source§

type Relationship = RelationshipSchema

Source§

fn name(&self) -> &str

ResourceSchema::name → the JSON:API type.
Source§

fn relationships(&self) -> &[RelationshipSchema]

Every declared relationship.
Source§

fn base_path(&self) -> &str

Where the resource is mounted, e.g. /api/v1/todos. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Mounted<'a>

§

impl<'a> RefUnwindSafe for Mounted<'a>

§

impl<'a> Send for Mounted<'a>

§

impl<'a> Sync for Mounted<'a>

§

impl<'a> Unpin for Mounted<'a>

§

impl<'a> UnsafeUnpin for Mounted<'a>

§

impl<'a> UnwindSafe for Mounted<'a>

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<B> FromRef<B> for B
where B: Clone,

Source§

fn from_ref(backend: &B) -> B

Extract a Self from a reference to the composite backend B.
Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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