Struct Run 

pub struct Run {
    pub content: RunContent,
    pub char_shape_id: CharShapeIndex,
}

A run: a segment of content with a single character shape reference.

Runs are the leaf nodes of the document tree. A paragraph contains one or more runs. Adjacent runs with the same char_shape_id could theoretically be merged, but Core preserves the original structure.

Examples

use hwpforge_core::run::Run;
use hwpforge_foundation::CharShapeIndex;

let run = Run::text("paragraph text", CharShapeIndex::new(0));
assert!(run.content.is_text());

Fields

content: RunContent

The content of this run.

char_shape_id: CharShapeIndex

Index into the character shape collection (Blueprint resolves this).

Implementations

impl Run

pub fn text(s: impl Into<String>, char_shape_id: CharShapeIndex) -> Self

Creates a text run.

This is the most common constructor. Most runs in a typical document are text.

Examples

use hwpforge_core::run::Run;
use hwpforge_foundation::CharShapeIndex;

let run = Run::text("Hello", CharShapeIndex::new(0));
assert_eq!(run.content.as_text(), Some("Hello"));

pub fn table(table: Table, char_shape_id: CharShapeIndex) -> Self

Creates a table run. The table is automatically boxed.

Examples

use hwpforge_core::run::Run;
use hwpforge_core::table::Table;
use hwpforge_foundation::CharShapeIndex;

let table = Table::new(vec![]);
let run = Run::table(table, CharShapeIndex::new(0));
assert!(run.content.is_table());

pub fn image(image: Image, char_shape_id: CharShapeIndex) -> Self

Creates an image run.

Examples

use hwpforge_core::run::Run;
use hwpforge_core::image::{Image, ImageFormat};
use hwpforge_foundation::{HwpUnit, CharShapeIndex};

let img = Image::new("test.png", HwpUnit::ZERO, HwpUnit::ZERO, ImageFormat::Png);
let run = Run::image(img, CharShapeIndex::new(0));
assert!(run.content.is_image());

pub fn control(control: Control, char_shape_id: CharShapeIndex) -> Self

Creates a control run. The control is automatically boxed.

Examples

use hwpforge_core::run::Run;
use hwpforge_core::control::Control;
use hwpforge_foundation::CharShapeIndex;

let link = Control::Hyperlink {
    text: "Click".to_string(),
    url: "https://example.com".to_string(),
};
let run = Run::control(link, CharShapeIndex::new(0));
assert!(run.content.is_control());

Trait Implementations

impl Clone for Run

fn clone(&self) -> Run

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Run

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Run

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Run

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

Formats the value using the given formatter.

impl JsonSchema for Run

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 Run

fn eq(&self, other: &Run) -> 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 Run

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 Run