Skip to main content

KindMeta

Struct KindMeta 

Source
pub struct KindMeta {
    pub kind: ResourceKind,
    pub domain: Domain,
    pub collection_path: &'static str,
    pub dir_name: &'static str,
    pub channel: Channel,
    pub volatile_fields: &'static [&'static str],
    pub read_only_fields: &'static [&'static str],
    pub secret_fields: &'static [&'static str],
    pub write_only_fields: &'static [&'static str],
    pub sidecar_fields: &'static [&'static str],
    pub reference_fields: &'static [RefField],
    pub immutable_fields: &'static [&'static str],
}
Expand description

Declarative metadata for one resource kind.

Fields§

§kind: ResourceKind§domain: Domain§collection_path: &'static str

API collection path (exact casing as the REST API expects).

§dir_name: &'static str

Directory name on disk, relative to the project’s search/ or foundry/ dir.

§channel: Channel

Minimum channel required for the kind itself.

§volatile_fields: &'static [&'static str]

Stripped on pull and ignored in diff (dot paths, applied at any depth for @odata.*; top-level otherwise).

§read_only_fields: &'static [&'static str]

Returned by GET but rejected by PUT — never written to files.

§secret_fields: &'static [&'static str]

Paths that may carry key material — validation rejects files where these contain anything but identity-based placeholders.

§write_only_fields: &'static [&'static str]

Fields the server accepts on PUT but never returns on GET (redacted). Kept in local files, sent on push, excluded from comparisons.

§sidecar_fields: &'static [&'static str]

String fields extracted to Markdown sidecars on pull by default.

§reference_fields: &'static [RefField]

How this kind references other resources.

§immutable_fields: &'static [&'static str]

Fields the service will not change in place — a differing local value means an in-place PUT cannot reconcile the documents and the resource must be deleted and re-created (rigg push shows replace).

Trait Implementations§

Source§

impl Clone for KindMeta

Source§

fn clone(&self) -> KindMeta

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 Copy for KindMeta

Source§

impl Debug for KindMeta

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