Enum RunContent 

#[non_exhaustive]
pub enum RunContent {
    Text(String),
    Table(Box<Table>),
    Image(Image),
    Control(Box<Control>),
}

The content of a run.

Marked #[non_exhaustive] so future content types can be added without a breaking change.

Design Decision

Table and Control are boxed to keep the enum size small. The common case (Text) is 24 bytes (a String). Without boxing, the enum would be ~88 bytes (dominated by the Control variant).

Examples

use hwpforge_core::run::RunContent;

let text = RunContent::Text("Hello".to_string());
assert!(text.is_text());
assert_eq!(text.as_text(), Some("Hello"));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text(String)

Plain text.

Table(Box<Table>)

An inline table (boxed for enum size optimization).

Image(Image)

An inline image.

Control(Box<Control>)

A control element (boxed for enum size optimization).

Implementations

impl RunContent

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

Returns the text content if this is a Text variant.

Examples

use hwpforge_core::run::RunContent;

let content = RunContent::Text("hello".to_string());
assert_eq!(content.as_text(), Some("hello"));

let content = RunContent::Text(String::new());
assert_eq!(content.as_text(), Some(""));

pub fn as_table(&self) -> Option<&Table>

Returns the table if this is a Table variant.

pub fn as_image(&self) -> Option<&Image>

Returns the image if this is an Image variant.

pub fn as_control(&self) -> Option<&Control>

Returns the control if this is a Control variant.

pub fn is_text(&self) -> bool

Returns true if this is a Text variant.

pub fn is_table(&self) -> bool

Returns true if this is a Table variant.

pub fn is_image(&self) -> bool

Returns true if this is an Image variant.

pub fn is_control(&self) -> bool

Returns true if this is a Control variant.

Trait Implementations

impl Clone for RunContent

fn clone(&self) -> RunContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RunContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RunContent

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

Formats the value using the given formatter.

impl JsonSchema for RunContent

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for RunContent

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for RunContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RunContent