Struct GeneratedContent

Source

pub struct GeneratedContent { /* private fields */ }

Expand description

A piece of generated structured content.

Apple models structured generations as GeneratedContent; the Rust wrapper stores the JSON value plus the metadata that Apple’s streaming API exposes.

Implementations§

Source §

impl GeneratedContent

Source

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

Parse a JSON string into generated content.

§Errors

Returns FMError::InvalidArgument if json is not valid JSON.

Source

pub fn from_json_str_with_id( json: &str, generation_id: impl Into<Option<GenerationId>>, ) -> Result<Self, FMError>

Parse a JSON string into generated content with an attached generation ID.

§Errors

Returns FMError::InvalidArgument if json is not valid JSON.

Source

pub fn from_value<T>(value: T) -> Result<Self, FMError>
where T: Serialize,

Convert a serializable Rust value into generated content.

§Errors

Returns FMError::InvalidArgument if value cannot be encoded as JSON.

Source

pub fn from_value_with_id<T>( value: T, generation_id: impl Into<Option<GenerationId>>, ) -> Result<Self, FMError>
where T: Serialize,

Convert a serializable Rust value into generated content with an ID.

§Errors

Returns FMError::InvalidArgument if value cannot be encoded as JSON.

Source

pub fn from_kind(kind: GeneratedContentKind) -> Result<Self, FMError>

Build generated content from a GeneratedContentKind value.

§Errors

Returns FMError::InvalidArgument if the kind cannot be represented as valid JSON.

Source

pub fn from_kind_with_id( kind: GeneratedContentKind, generation_id: impl Into<Option<GenerationId>>, ) -> Result<Self, FMError>

Build generated content from a GeneratedContentKind value with an ID.

§Errors

Returns FMError::InvalidArgument if the kind cannot be represented as valid JSON.

Source

pub fn from_elements<T>( elements: impl IntoIterator<Item = T>, ) -> Result<Self, FMError>
where T: ToGeneratedContent,

Build generated content from a sequence of values.

§Errors

Returns FMError if any element cannot be converted.

Source

pub fn from_elements_with_id<T>( elements: impl IntoIterator<Item = T>, generation_id: impl Into<Option<GenerationId>>, ) -> Result<Self, FMError>
where T: ToGeneratedContent,

Build generated content from a sequence of values with an ID.

§Errors

Returns FMError if any element cannot be converted.

Source

pub fn from_properties<K, V>( properties: impl IntoIterator<Item = (K, V)>, ) -> Result<Self, FMError>
where K: Into<String>, V: ToGeneratedContent,

Build generated content from key/value properties.

Later duplicates overwrite earlier ones.

§Errors

Returns FMError if any value cannot be converted.

Source

pub fn from_properties_with_id<K, V>( properties: impl IntoIterator<Item = (K, V)>, generation_id: impl Into<Option<GenerationId>>, ) -> Result<Self, FMError>
where K: Into<String>, V: ToGeneratedContent,

Build generated content from key/value properties with an ID.

Later duplicates overwrite earlier ones.

§Errors

Returns FMError if any value cannot be converted.

Source

pub fn from_properties_with<K, V, F>( properties: impl IntoIterator<Item = (K, V)>, generation_id: impl Into<Option<GenerationId>>, combine: F, ) -> Result<Self, FMError>
where K: Into<String>, V: ToGeneratedContent, F: FnMut(GeneratedContent, GeneratedContent) -> Result<GeneratedContent, FMError>,

Build generated content from key/value properties, combining duplicates.

§Errors

Returns FMError if any value cannot be converted or combine fails.

Source

pub const fn raw_value(&self) -> &Value

Return the underlying JSON value.

Source

pub fn into_raw_value(self) -> Value

Consume the content and return the underlying JSON value.

Source

pub fn kind(&self) -> GeneratedContentKind

Return the typed content kind.

Source

pub fn json_string(&self) -> Result<String, FMError>

Serialize the content back to a compact JSON string.

§Errors

Returns FMError::Unknown if serialization fails.

Source

pub fn json_string_pretty(&self) -> Result<String, FMError>

Serialize the content as pretty JSON.

§Errors

Returns FMError::Unknown if serialization fails.

Source

pub fn value<T>(&self) -> Result<T, FMError>
where T: DeserializeOwned,

Decode the content into a Rust value.

§Errors

Returns FMError::DecodingFailure if the JSON value does not match T.

Source

pub fn value_for_property<T>(&self, property: &str) -> Result<T, FMError>
where T: DeserializeOwned,

Decode a named property from an object content value.

§Errors

Returns FMError::DecodingFailure if the value is not an object, the property does not exist, or the property cannot be decoded as T.

Source

pub const fn is_complete(&self) -> bool

Whether Apple’s structured stream reported this content as complete.

Source

pub fn generation_id(&self) -> Option<&str>

Apple’s opaque generation identifier, if one was attached.

Source

pub fn generation_id_handle(&self) -> Option<&GenerationId>

Borrow the typed generation identifier handle, if one was attached.

Source

pub fn with_generation_id( self, generation_id: impl Into<Option<GenerationId>>, ) -> Self

Replace the attached generation identifier.

Trait Implementations§

Source §

impl Clone for GeneratedContent

Source §

fn clone(&self) -> GeneratedContent

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 GeneratedContent

Source §

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

Formats the value using the given formatter. Read more

Source §