Enum AnnotLinkAction 

#[non_exhaustive]
pub enum AnnotLinkAction {
    Uri(String),
    GoTo {
        page: ObjRef,
        view: AnnotGoToView,
    },
    Named {
        name: String,
        page: ObjRef,
        view: AnnotGoToView,
    },
    NamedExisting {
        name: String,
    },
    GoToR {
        file: String,
        dest: AnnotRemoteDest,
        new_window: Option<bool>,
    },
    Launch {
        file: String,
    },
}

Write-side link action, aligned with pdfrum_doc::ActionKind values we support on annotations.

Reuses the document Action model conceptually (URI, GoTo); this enum is the typed payload AnnotSpec::Link writes into /A. A Self::Named action also upserts /Names /Dests so reopen/navigation can resolve the name (see set_named_destination). Self::NamedExisting writes the same /D string but does not touch the name tree — use it when the destination is already registered.

use pdfrum_edit::AnnotLinkAction;

let a = AnnotLinkAction::Uri("https://example.test/".into());
assert!(matches!(a, AnnotLinkAction::Uri(_)));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Uri(String)

Resolve a URI (/S /URI).

GoTo

Go to a page in this document (/S /GoTo with an explicit destination array naming page).

Fields

page: ObjRef

Page object reference (the same refs crate::EditDoc::page_state returns).

view: AnnotGoToView

How to display that page.

Named

GoTo whose /D is a named destination string.

Also registers (or updates) name under the catalog /Names /Dests tree so pdfrum_doc::nav::lookup_named_dest can resolve it after save.

Fields

name: String

Destination name written as /D and as the name-tree key.

page: ObjRef

Page the name resolves to.

view: AnnotGoToView

How to display that page.

NamedExisting

GoTo whose /D is a named destination that must already exist.

Unlike Self::Named, this does not upsert /Names /Dests — the name is assumed to resolve already (or will be registered separately via set_named_destination).

Fields

name: String

Destination name written as /D.

GoToR

Remote go-to (/S /GoToR): open file at AnnotRemoteDest.

/F is written as a filespec dictionary with /F and /UF.

Fields

file: String

Remote file path (filespec /F + /UF).

dest: AnnotRemoteDest

Page number + view, or a remote named destination.

new_window: Option<bool>

Optional /NewWindow.

Launch

Launch a file / application (/S /Launch).

/F is written as a filespec dictionary with /F and /UF.

Fields

file: String

File / application path (filespec /F + /UF).

Trait Implementations

impl Clone for AnnotLinkAction

fn clone(&self) -> AnnotLinkAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotLinkAction

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

Formats the value using the given formatter.

impl PartialEq for AnnotLinkAction

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AnnotLinkAction