Struct LinkSpec 

pub struct LinkSpec { /* private fields */ }

A link annotation (/Subtype /Link).

The action is required, so it is taken at construction; the constructors mirror AnnotSpec’s link family.

use kurbo::Rect;
use pdfrum_edit::{AnnotLinkHighlight, AnnotSpec, LinkSpec};

let spec: AnnotSpec = LinkSpec::uri(Rect::new(0.0, 0.0, 50.0, 10.0), "https://example.com")
    .highlight(AnnotLinkHighlight::Outline)
    .into();

Implementations

impl LinkSpec

pub fn new(rect: Rect, action: AnnotLinkAction) -> Self

A link at rect running action.

pub fn uri(rect: Rect, uri: impl Into<String>) -> Self

A link opening uri.

pub fn goto(rect: Rect, page: ObjRef, view: AnnotGoToView) -> Self

A link jumping to page in this document.

pub fn named( rect: Rect, name: impl Into<String>, page: ObjRef, view: AnnotGoToView, ) -> Self

A link to a named destination, registering name on write.

pub fn named_existing(rect: Rect, name: impl Into<String>) -> Self

A link to a destination the document already names.

pub fn goto_r( rect: Rect, file: impl Into<String>, page: i64, view: AnnotGoToView, ) -> Self

A link into another file, at a page number and view.

pub fn goto_r_named( rect: Rect, file: impl Into<String>, name: impl Into<String>, ) -> Self

A link into another file, at a destination that file names.

pub fn launch(rect: Rect, file: impl Into<String>) -> Self

A link that launches a file or application.

pub fn color(self, color: Color) -> Self

Sets /C, the colour of the link’s border chrome.

pub fn border(self, border: AnnotBorder) -> Self

Sets /BS width and style.

pub fn highlight(self, highlight: AnnotLinkHighlight) -> Self

Sets /H, the viewer’s click feedback. Defaults to Invert.

impl LinkSpec

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

A link annotation.

Sets /Contents.

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

A link annotation.

Sets /T, the author.

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

A link annotation.

Sets /NM, the annotation’s unique name.

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

A link annotation.

Sets /M, the modification date.

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

A link annotation.

Sets /F, the annotation flags.

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

A link annotation.

Sets every metadata field at once.

Trait Implementations

impl Clone for LinkSpec

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 LinkSpec

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

Formats the value using the given formatter.

impl From<LinkSpec> for AnnotWrite

fn from(builder: LinkSpec) -> Self

Converts to this type from the input type.

impl From<LinkSpec> for AnnotSpec

fn from(b: LinkSpec) -> Self

Converts to this type from the input type.

impl PartialEq for LinkSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LinkSpec