Struct MarkupSpec 

pub struct MarkupSpec { /* private fields */ }

A text-markup annotation: Highlight, Underline, StrikeOut, or Squiggly.

The four share a shape — a colour and a set of /QuadPoints — so one builder covers them and MarkupKind picks the subtype.

use kurbo::Rect;
use peniko::Color;
use pdfrum_edit::{AnnotSpec, MarkupKind, MarkupSpec};

let rect = Rect::new(0.0, 0.0, 80.0, 12.0);
let spec: AnnotSpec = MarkupSpec::new(MarkupKind::Highlight, rect, Color::from_rgb8(255, 255, 0))
    .quads([rect.into()])
    .contents("note")
    .into();

Implementations

impl MarkupSpec

pub fn new(kind: MarkupKind, rect: Rect, color: Color) -> Self

A markup annotation covering rect as a single quadrilateral.

Replace the geometry with MarkupSpec::quads to mark up a selection of several runs.

pub fn quads(self, quads: impl IntoIterator<Item = Quad>) -> Self

Replaces the /QuadPoints, one quadrilateral per marked run.

Writing a spec whose quads are empty fails with crate::Error::EmptyQuadPoints. pdfrum_text::rects_loose gives the em-box rectangles Acrobat marks up.

impl MarkupSpec

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

A text-markup annotation.

Sets /Contents.

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

A text-markup annotation.

Sets /T, the author.

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

A text-markup annotation.

Sets /NM, the annotation’s unique name.

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

A text-markup annotation.

Sets /M, the modification date.

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

A text-markup annotation.

Sets /F, the annotation flags.

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

A text-markup annotation.

Sets every metadata field at once.

Trait Implementations

impl Clone for MarkupSpec

fn clone(&self) -> MarkupSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkupSpec

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

Formats the value using the given formatter.

impl From<MarkupSpec> for AnnotWrite

fn from(builder: MarkupSpec) -> Self

Converts to this type from the input type.

impl From<MarkupSpec> for AnnotSpec

fn from(b: MarkupSpec) -> Self

Converts to this type from the input type.

impl PartialEq for MarkupSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MarkupSpec