Struct AnnotWrite 

pub struct AnnotWrite {
    pub spec: AnnotSpec,
    pub meta: AnnotMeta,
}

An AnnotSpec plus optional AnnotMeta for writing.

Fields

spec: AnnotSpec

Subtype-specific fields.

meta: AnnotMeta

Author / name / date.

Implementations

impl AnnotWrite

pub fn with_contents(self, contents: impl Into<String>) -> Self

Sets /Contents on the inner spec (same rules as AnnotSpec::with_contents).

pub fn with_author(self, author: impl Into<String>) -> Self

Sets /T.

pub fn with_name(self, name: impl Into<String>) -> Self

Sets /NM.

pub fn with_modified(self, modified: impl Into<String>) -> Self

Sets /M.

pub fn with_meta(self, meta: AnnotMeta) -> Self

Replaces the full metadata block.

pub fn with_flags(self, flags: AnnotFlags) -> Self

Sets /F annotation flags.

pub fn with_opacity(self, opacity: f32) -> Self

Sets /CA, the constant opacity, from 0.0 to 1.0.

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

Sets /Contents. The bare-verb spelling the typed builders use, so a chain that starts on a builder keeps reading the same way after the first metadata setter hands back an AnnotWrite.

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

Sets /T, the author. See AnnotWrite::contents on the spelling.

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

Sets /NM, the annotation’s unique name.

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

Sets /M, the modification date.

pub fn flags(self, flags: AnnotFlags) -> Self

Sets /F, the annotation flags.

pub fn meta(self, meta: AnnotMeta) -> Self

Sets every metadata field at once.

Trait Implementations

impl Clone for AnnotWrite

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotWrite

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

Formats the value using the given formatter.

impl From<AnnotSpec> for AnnotWrite

fn from(spec: AnnotSpec) -> Self

Converts to this type from the input type.

impl From<CaretSpec> for AnnotWrite

fn from(builder: CaretSpec) -> Self

Converts to this type from the input type.

impl From<CircleSpec> for AnnotWrite

fn from(builder: CircleSpec) -> Self

Converts to this type from the input type.

impl From<FreeTextSpec> for AnnotWrite

fn from(builder: FreeTextSpec) -> Self

Converts to this type from the input type.

impl From<InkSpec> for AnnotWrite

fn from(builder: InkSpec) -> Self

Converts to this type from the input type.

impl From<LineSpec> for AnnotWrite

fn from(builder: LineSpec) -> Self

Converts to this type from the input type.

impl From<LinkSpec> for AnnotWrite

fn from(builder: LinkSpec) -> Self

Converts to this type from the input type.

impl From<MarkupSpec> for AnnotWrite

fn from(builder: MarkupSpec) -> Self

Converts to this type from the input type.

impl From<SquareSpec> for AnnotWrite

fn from(builder: SquareSpec) -> Self

Converts to this type from the input type.

impl From<TextSpec> for AnnotWrite

fn from(builder: TextSpec) -> Self

Converts to this type from the input type.

impl PartialEq for AnnotWrite

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AnnotWrite