Struct DocApiToc 

pub struct DocApiToc<'a, I: Invoker> { /* private fields */ }

Implementations

impl<'a, I: Invoker> DocApiToc<'a, I>

pub fn new(invoker: &'a I) -> Self

pub fn configure<'call>( &'call self, params: &'call DocTocConfigureBoundParams, ) -> impl Future<Output = Result<DocTocConfigureResult>> + Send + 'call

Update the configuration switches of a table of contents.

pub async fn configure_with_options( &self, params: &DocTocConfigureBoundParams, options: InvokeOptions, ) -> Result<DocTocConfigureResult>

Update the configuration switches of a table of contents.

pub fn edit_entry<'call>( &'call self, params: &'call DocTocEditEntryBoundParams, ) -> impl Future<Output = Result<DocTocEditEntryResult>> + Send + 'call

Update the properties of a TC (table of contents entry) field.

pub async fn edit_entry_with_options( &self, params: &DocTocEditEntryBoundParams, options: InvokeOptions, ) -> Result<DocTocEditEntryResult>

Update the properties of a TC (table of contents entry) field.

pub fn get<'call>( &'call self, params: &'call DocTocGetBoundParams, ) -> impl Future<Output = Result<DocTocGetResult>> + Send + 'call

Retrieve details of a specific table of contents.

pub async fn get_with_options( &self, params: &DocTocGetBoundParams, options: InvokeOptions, ) -> Result<DocTocGetResult>

Retrieve details of a specific table of contents.

pub fn get_entry<'call>( &'call self, params: &'call DocTocGetEntryBoundParams, ) -> impl Future<Output = Result<DocTocGetEntryResult>> + Send + 'call

Retrieve details of a specific TC (table of contents entry) field.

pub async fn get_entry_with_options( &self, params: &DocTocGetEntryBoundParams, options: InvokeOptions, ) -> Result<DocTocGetEntryResult>

Retrieve details of a specific TC (table of contents entry) field.

pub fn list<'call>( &'call self, params: &'call DocTocListBoundParams, ) -> impl Future<Output = Result<DocTocListResult>> + Send + 'call

List all tables of contents in the document.

pub async fn list_with_options( &self, params: &DocTocListBoundParams, options: InvokeOptions, ) -> Result<DocTocListResult>

List all tables of contents in the document.

pub fn list_entries<'call>( &'call self, params: &'call DocTocListEntriesBoundParams, ) -> impl Future<Output = Result<DocTocListEntriesResult>> + Send + 'call

List all TC (table of contents entry) fields in the document body.

pub async fn list_entries_with_options( &self, params: &DocTocListEntriesBoundParams, options: InvokeOptions, ) -> Result<DocTocListEntriesResult>

List all TC (table of contents entry) fields in the document body.

pub fn mark_entry<'call>( &'call self, params: &'call DocTocMarkEntryBoundParams, ) -> impl Future<Output = Result<DocTocMarkEntryResult>> + Send + 'call

Insert a TC (table of contents entry) field at the target paragraph.

pub async fn mark_entry_with_options( &self, params: &DocTocMarkEntryBoundParams, options: InvokeOptions, ) -> Result<DocTocMarkEntryResult>

Insert a TC (table of contents entry) field at the target paragraph.

pub fn remove<'call>( &'call self, params: &'call DocTocRemoveBoundParams, ) -> impl Future<Output = Result<DocTocRemoveResult>> + Send + 'call

Remove a table of contents from the document.

pub async fn remove_with_options( &self, params: &DocTocRemoveBoundParams, options: InvokeOptions, ) -> Result<DocTocRemoveResult>

Remove a table of contents from the document.

pub fn unmark_entry<'call>( &'call self, params: &'call DocTocUnmarkEntryBoundParams, ) -> impl Future<Output = Result<DocTocUnmarkEntryResult>> + Send + 'call

Remove a TC (table of contents entry) field from the document.

pub async fn unmark_entry_with_options( &self, params: &DocTocUnmarkEntryBoundParams, options: InvokeOptions, ) -> Result<DocTocUnmarkEntryResult>

Remove a TC (table of contents entry) field from the document.

pub fn update<'call>( &'call self, params: &'call DocTocUpdateBoundParams, ) -> impl Future<Output = Result<DocTocUpdateResult>> + Send + 'call

Rebuild or refresh the materialized content of a table of contents.

pub async fn update_with_options( &self, params: &DocTocUpdateBoundParams, options: InvokeOptions, ) -> Result<DocTocUpdateResult>

Rebuild or refresh the materialized content of a table of contents.