Struct AnnotMeta 

pub struct AnnotMeta {
    pub author: Option<String>,
    pub name: Option<String>,
    pub modified: Option<String>,
    pub flags: Option<AnnotFlags>,
    pub opacity: Option<f32>,
}

Optional dictionary fields common to every annotation subtype.

Applied when writing via add_annotation / AnnotWrite.

/F defaults to AnnotFlags::PRINT when Self::flags is None.

Fields

author: Option<String>

Author / title string written as /T.

name: Option<String>

Unique name written as /NM (often an application id).

modified: Option<String>

Modification date written as /M (PDF date string).

flags: Option<AnnotFlags>

Annotation flags written as /F. None means AnnotFlags::PRINT.

opacity: Option<f32>

Constant opacity written as /CA, from 0.0 (invisible) to 1.0.

None writes no key, which a reader takes as fully opaque. The appearance generator reads /CA into the stream’s /ExtGState, so a written one is honoured without the caller drawing anything.

Implementations

impl AnnotMeta

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 to a PDF date string.

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

Sets /F annotation flags.

use pdfrum_doc::AnnotFlags;
use pdfrum_edit::AnnotMeta;

let meta = AnnotMeta::default().with_flags(AnnotFlags::PRINT | AnnotFlags::NO_ZOOM);
assert_eq!(meta.flags, Some(AnnotFlags::PRINT | AnnotFlags::NO_ZOOM));

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

Sets /CA, the constant opacity, clamped to 0.0..=1.0 when written.

use pdfrum_edit::AnnotMeta;

assert_eq!(AnnotMeta::default().with_opacity(0.4).opacity, Some(0.4));

Trait Implementations

impl Clone for AnnotMeta

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 AnnotMeta

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

Formats the value using the given formatter.

impl Default for AnnotMeta

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for AnnotMeta

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AnnotMeta