Struct Footnote 

pub struct Footnote {
    pub content: Box<Value>,
    pub marker: Option<Box<Value>>,
    pub show: bool,
    /* private fields */
}

A footnote in a PivotTable.

A footnote is attached directly to a Value, but it will only be displayed correctly if it is also added to PivotTable::footnotes for its pivot table.

Fields

content: Box<Value>

The footnote text.

marker: Option<Box<Value>>

The footnote marker.

This is usually None, in which case FootnoteMarkerType determines the default marker.

show: bool

Whether to show the footnote.

Implementations

impl Footnote

pub fn new(content: impl Into<Value>) -> Self

Constructs a new footnote.

pub fn with_marker(self, marker: Option<Value>) -> Self

Returns the footnote with the given optional marker.

pub fn with_some_marker(self, marker: impl Into<Value>) -> Self

Returns the footnote with the given marker.

pub fn with_show(self, show: bool) -> Self

Return the footnote with the given show.

pub fn with_index(self, index: usize) -> Self

Return the footnote with the given index.

pub fn display_marker(&self, options: impl Into<ValueOptions>) -> impl Display

Returns an object for formatting the footnote’s marker.

pub fn display_content(&self, options: impl Into<ValueOptions>) -> impl Display

Returns an object for formatting the footnote’s text.

pub fn index(&self) -> usize

Returns the footnote’s index.

Trait Implementations

impl BinWrite for Footnote

type Args<'a> = ()

The type used for the args parameter of write_args() and write_options().

fn write_options<W: Write + Seek>( &self, writer: &mut W, endian: Endian, args: Self::Args<'_>, ) -> BinResult<()>

Write Self to the writer using the given Endian and arguments.

fn write_be<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order.

fn write_le<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order.

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments.

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments.

impl Clone for Footnote

fn clone(&self) -> Footnote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Footnote

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

Formats the value using the given formatter.

impl Default for Footnote

fn default() -> Self

Returns the “default value” for a type.

impl FromIterator<Footnote> for Footnotes

fn from_iter<T: IntoIterator<Item = Footnote>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq for Footnote

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Footnote

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Footnote