Struct Format

pub struct Format { /* private fields */ }

Structure that combines a Statement resource GET request format parameter along w/ the request’s Accept-Language, potentially empty, list of user-preferred language-tags, in descending order of preference. This is provided to facilitate reducing types to their canonical form when required by higher layer APIs.

Fields included in Format variants

The next table shows for each Format variant, except exact, which fields are included when generating a response to a GET Statement resource call. The reason exact is not shown is b/c in that case all fields are included.

Entity	Field	ids	canonical
Statement	id	✓	✓
	actor	✓	✓
	verb	✓	✓
	object	✓	✓
	result		✓
	context		✓
	timestamp
	stored
	authority	✓	✓
	version
Agent	id	✓	✓
	ifi [1, 2]	✓	✓
Group	id	✓	✓
	ifi [1, 2]	✓	✓
	members	✓	✓
Verb	id	✓	✓
	display [3]		✓
Activity	id	✓	✓
	definition		✓
ActivityDefinition	name		✓
	description		✓
	type_		✓
	more_info		✓
	interaction_type		✓
	correct_responses_pattern		✓
	choices		✓
	scale		✓
	source		✓
	target		✓
	steps		✓
	extensions		✓
InteractionComponent	id		✓
	description		✓
StatementRef	id	✓	✓
SubStatement	actor	✓	✓
	verb	✓	✓
	object	✓	✓
	result		✓
	context		✓
	timestamp

Notes:

1. The term ifi refers to either one of the following four Inverse Functional Identifier fields: mbox, mbox_sha1sum, openid or account.
2. With ids and canonical variants, only one (1) IFI is included in the output. However, with exact all known IFIs are included.
3. display like all LanguageMap instances are included in canonical with only one (1) language tag entry. With exact again all entries are included. For more information read LanguageMap Requirements

Implementations

impl Format

pub fn new(s: &str, tags: Vec<MyLanguageTag>) -> Result<Self, DataError>

Return a new instance given a format string and a potentially empty list of user provided language tags expected to be in descending order of preference.

pub fn from(tags: Vec<MyLanguageTag>) -> Self

Return a new instance w/ an exact format and a potentially empty list of user provided language tags expected to be in descending order of preference.

pub fn is_ids(&self) -> bool

Return TRUE if the wrapped format is the ids variant.

pub fn is_exact(&self) -> bool

Return TRUE if the wrapped format is the exact variant.

pub fn is_canonical(&self) -> bool

Return TRUE if the wrapped format is the cnonical variant.

pub fn as_param(&self) -> &FormatParam

Return a reference to this format key when used as a query parameter.

pub fn tags(&self) -> &[MyLanguageTag]

Return a reference to the list of language tags provided at construction time.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Format

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

Formats the value using the given formatter.

impl Default for Format

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Format

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Format

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

Formats the value using the given formatter.

impl Serialize for Format

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.