Skip to main content

OptionalContentGroup

Struct OptionalContentGroup 

Source
pub struct OptionalContentGroup {
    pub id: ObjectId,
    pub name: String,
    pub intents: Vec<String>,
    pub usage: Option<OcUsage>,
}
Expand description

One Optional Content Group (ISO 32000-1 §8.11.2 Table 98).

Surfaced verbatim from the document — the state slot on this struct is not filled in by optional_content; resolved states live in OptionalContent::states keyed by group id (the /OCProperties /OCGs array is the source of truth for “which objects are OCGs”, which lets callers cross-walk against e.g. content-stream /OC /OCx BDC resource names).

Fields§

§id: ObjectId

Indirect object id — the OCG dict’s (n 0 obj) number. Used by content streams + OCMDs to refer to the group.

§name: String

/Name — UI label. PDF text string (literal or hex with optional UTF-16BE BOM).

§intents: Vec<String>

/IntentView / Design / both. Empty array on input surfaces as an empty vec (per §8.11.2.3 “If the configuration’s Intent is an empty array, no groups shall be used in determining visibility”).

§usage: Option<OcUsage>

/Usage subkeys (Table 102). The most-used ones get typed slots; everything else stays in the raw dict.

Trait Implementations§

Source§

impl Clone for OptionalContentGroup

Source§

fn clone(&self) -> OptionalContentGroup

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OptionalContentGroup

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V