Skip to main content

CaseSet

Struct CaseSet 

Source
pub struct CaseSet {
    pub version: Option<u32>,
    pub cases: Vec<Case>,
}
Expand description

A batch of Cases loaded from one YAML/JSON document: the config-file counterpart of hand-assembling many Questions values in code.

See the module-level docs for the file format.

Fields§

§version: Option<u32>

Format version of this file, for callers that need to evolve the schema. Not otherwise interpreted by this SDK.

§cases: Vec<Case>

The cases, in file order.

Implementations§

Source§

impl CaseSet

Source

pub fn from_json_str(json: &str) -> Result<Self, Error>

Parses a CaseSet from a JSON document.

§Errors

Error::Parse if json is not valid JSON; Error::Invalid if it parses but fails case-set validation (see the module-level docs).

Source

pub fn from_json_value(value: Value) -> Result<Self, Error>

Parses a CaseSet from an already-parsed JSON value.

§Errors

Error::Parse if value does not match the case-set schema; Error::Invalid if it parses but fails case-set validation.

Source

pub fn from_yaml_str(yaml: &str) -> Result<Self, Error>

Parses a CaseSet from a YAML document.

§Errors

Error::Parse if yaml is not valid YAML; Error::Invalid if it parses but fails case-set validation.

Source

pub async fn from_file(path: impl AsRef<Path>) -> Result<Self, Error>

Loads a CaseSet from a file, choosing the JSON or YAML parser by extension (.json vs. .yaml/.yml).

Reads the file with tokio::fs, not std::fs, so it never blocks the async runtime’s worker thread.

§Errors

Error::Io if the file cannot be read; Error::Invalid if the extension is missing, unrecognized, or names a YAML file while the yaml feature is disabled, or if the parsed content fails case-set validation; Error::Parse if the content is not well-formed JSON/YAML.

Source

pub fn len(&self) -> usize

The number of cases.

Source

pub fn is_empty(&self) -> bool

Whether there are no cases.

Never true for a successfully loaded CaseSet: loading rejects an empty cases list. Provided for API symmetry with Vec::is_empty and to satisfy clippy::len_without_is_empty.

Source

pub fn iter(&self) -> Iter<'_, Case> ⓘ

Iterates cases in file order.

Source

pub fn as_slice(&self) -> &[Case]

Borrows the cases as a slice, for crate::run_cases.

Trait Implementations§

Source§

impl Clone for CaseSet

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 Debug for CaseSet

Source§

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

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

impl<'de> Deserialize<'de> for CaseSet

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<'a> IntoIterator for &'a CaseSet

Source§

type Item = &'a Case

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, Case>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for CaseSet

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CaseSet

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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