DataDescriptor

Struct DataDescriptor 

Source
pub struct DataDescriptor {
    pub id: DescriptorId,
    pub version: DescriptorVersion,
    pub label: Option<String>,
    pub settable: bool,
    pub default: Option<Value>,
    pub schema: Option<String>,
    pub codecs: Vec<String>,
    pub converters: Vec<String>,
    pub feature_flags: Vec<String>,
    pub gpu: Option<GpuHints>,
    pub type_expr: Option<TypeExpr>,
}
Expand description

Descriptor for values/types.

use daedalus_data::descriptor::{DataDescriptor, DescriptorId, DescriptorVersion};
let desc = DataDescriptor {
    id: DescriptorId::new("example"),
    version: DescriptorVersion::new("1.0.0"),
    label: None,
    settable: false,
    default: None,
    schema: None,
    codecs: vec![],
    converters: vec![],
    feature_flags: vec![],
    gpu: None,
    type_expr: None,
};
assert_eq!(desc.id.0, "example");

Fields§

§id: DescriptorId§version: DescriptorVersion§label: Option<String>§settable: bool§default: Option<Value>§schema: Option<String>§codecs: Vec<String>§converters: Vec<String>§feature_flags: Vec<String>§gpu: Option<GpuHints>§type_expr: Option<TypeExpr>

Implementations§

Source§

impl DataDescriptor

Source

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

Validate the descriptor, including type/default compatibility.

use daedalus_data::descriptor::{DataDescriptor, DescriptorId, DescriptorVersion};
let desc = DataDescriptor {
    id: DescriptorId::new("example"),
    version: DescriptorVersion::new("1.0"),
    label: None,
    settable: false,
    default: None,
    schema: None,
    codecs: vec![],
    converters: vec![],
    feature_flags: vec![],
    gpu: None,
    type_expr: None,
};
desc.validate().unwrap();
Source

pub fn normalize(self) -> Self

Deterministic ordering for codecs/converters/feature flags.

use daedalus_data::descriptor::{DataDescriptor, DescriptorId, DescriptorVersion};
let desc = DataDescriptor {
    id: DescriptorId::new("id"),
    version: DescriptorVersion::new("1.0"),
    label: None,
    settable: false,
    default: None,
    schema: None,
    codecs: vec!["b".into(), "a".into()],
    converters: vec!["y".into(), "x".into()],
    feature_flags: vec!["b".into(), "a".into()],
    gpu: None,
    type_expr: None,
};
let sorted = desc.normalize();
assert_eq!(sorted.codecs, vec!["a", "b"]);

Trait Implementations§

Source§

impl Clone for DataDescriptor

Source§

fn clone(&self) -> DataDescriptor

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DataDescriptor

Source§

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

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

impl<'de> Deserialize<'de> for DataDescriptor

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for DataDescriptor

Source§

fn eq(&self, other: &DataDescriptor) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for DataDescriptor

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

impl StructuralPartialEq for DataDescriptor

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,