SurveyDefinition

Struct SurveyDefinition 

Source
pub struct SurveyDefinition {
    pub prelude: Option<String>,
    pub questions: Vec<Question>,
    pub epilogue: Option<String>,
}
Expand description

The top-level structure containing all questions and metadata for a survey.

A survey is a structured collection of questions. It’s presentation-agnostic — it can be rendered as a sequential interview, a fill-in form, or used to generate documents.

Fields§

§prelude: Option<String>

Optional message shown before the survey starts.

§questions: Vec<Question>

All questions in the survey (may contain nested AllOf/OneOf/AnyOf).

§epilogue: Option<String>

Optional message shown after the survey completes.

Implementations§

Source§

impl SurveyDefinition

Source

pub fn new(questions: Vec<Question>) -> Self

Create a new survey definition with the given questions.

Source

pub fn empty() -> Self

Create an empty survey definition.

Source

pub fn with_prelude(self, prelude: impl Into<String>) -> Self

Set the prelude message.

Source

pub fn with_epilogue(self, epilogue: impl Into<String>) -> Self

Set the epilogue message.

Source

pub fn questions(&self) -> &[Question]

Get the questions.

Source

pub fn questions_mut(&mut self) -> &mut Vec<Question>

Get a mutable reference to the questions.

Source

pub fn is_empty(&self) -> bool

Check if the survey has any questions.

Source

pub fn len(&self) -> usize

Get the number of top-level questions.

Trait Implementations§

Source§

impl Clone for SurveyDefinition

Source§

fn clone(&self) -> SurveyDefinition

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 SurveyDefinition

Source§

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

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

impl Default for SurveyDefinition

Source§

fn default() -> Self

Returns the “default value” for a type. 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.