Skip to main content

DocApiFormat

Struct DocApiFormat 

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

Implementations§

Source§

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

Source

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

Source

pub fn paragraph(&self) -> DocApiFormatParagraph<'a, I>

Source

pub fn apply<'call>( &'call self, params: &'call DocFormatApplyBoundParams, ) -> impl Future<Output = Result<DocFormatApplyResult>> + Send + 'call

Apply inline run-property patch changes to the target range with explicit set/clear semantics.

Source

pub async fn apply_with_options( &self, params: &DocFormatApplyBoundParams, options: InvokeOptions, ) -> Result<DocFormatApplyResult>

Apply inline run-property patch changes to the target range with explicit set/clear semantics.

Source

pub fn b_cs<'call>( &'call self, params: &'call DocFormatBCsBoundParams, ) -> impl Future<Output = Result<DocFormatBCsResult>> + Send + 'call

Set or clear the bCs inline run property on the target text range.

Source

pub async fn b_cs_with_options( &self, params: &DocFormatBCsBoundParams, options: InvokeOptions, ) -> Result<DocFormatBCsResult>

Set or clear the bCs inline run property on the target text range.

Source

pub fn bold<'call>( &'call self, params: &'call DocFormatBoldBoundParams, ) -> impl Future<Output = Result<DocFormatBoldResult>> + Send + 'call

Set or clear the bold inline run property on the target text range.

Source

pub async fn bold_with_options( &self, params: &DocFormatBoldBoundParams, options: InvokeOptions, ) -> Result<DocFormatBoldResult>

Set or clear the bold inline run property on the target text range.

Source

pub fn border<'call>( &'call self, params: &'call DocFormatBorderBoundParams, ) -> impl Future<Output = Result<DocFormatBorderResult>> + Send + 'call

Set or clear the border inline run property on the target text range.

Source

pub async fn border_with_options( &self, params: &DocFormatBorderBoundParams, options: InvokeOptions, ) -> Result<DocFormatBorderResult>

Set or clear the border inline run property on the target text range.

Source

pub fn caps<'call>( &'call self, params: &'call DocFormatCapsBoundParams, ) -> impl Future<Output = Result<DocFormatCapsResult>> + Send + 'call

Set or clear the caps inline run property on the target text range.

Source

pub async fn caps_with_options( &self, params: &DocFormatCapsBoundParams, options: InvokeOptions, ) -> Result<DocFormatCapsResult>

Set or clear the caps inline run property on the target text range.

Source

pub fn char_scale<'call>( &'call self, params: &'call DocFormatCharScaleBoundParams, ) -> impl Future<Output = Result<DocFormatCharScaleResult>> + Send + 'call

Set or clear the charScale inline run property on the target text range.

Source

pub async fn char_scale_with_options( &self, params: &DocFormatCharScaleBoundParams, options: InvokeOptions, ) -> Result<DocFormatCharScaleResult>

Set or clear the charScale inline run property on the target text range.

Source

pub fn color<'call>( &'call self, params: &'call DocFormatColorBoundParams, ) -> impl Future<Output = Result<DocFormatColorResult>> + Send + 'call

Set or clear the color inline run property on the target text range.

Source

pub async fn color_with_options( &self, params: &DocFormatColorBoundParams, options: InvokeOptions, ) -> Result<DocFormatColorResult>

Set or clear the color inline run property on the target text range.

Source

pub fn contextual_alternates<'call>( &'call self, params: &'call DocFormatContextualAlternatesBoundParams, ) -> impl Future<Output = Result<DocFormatContextualAlternatesResult>> + Send + 'call

Set or clear the contextualAlternates inline run property on the target text range.

Source

pub async fn contextual_alternates_with_options( &self, params: &DocFormatContextualAlternatesBoundParams, options: InvokeOptions, ) -> Result<DocFormatContextualAlternatesResult>

Set or clear the contextualAlternates inline run property on the target text range.

Source

pub fn cs<'call>( &'call self, params: &'call DocFormatCsBoundParams, ) -> impl Future<Output = Result<DocFormatCsResult>> + Send + 'call

Set or clear the cs inline run property on the target text range.

Source

pub async fn cs_with_options( &self, params: &DocFormatCsBoundParams, options: InvokeOptions, ) -> Result<DocFormatCsResult>

Set or clear the cs inline run property on the target text range.

Source

pub fn dstrike<'call>( &'call self, params: &'call DocFormatDstrikeBoundParams, ) -> impl Future<Output = Result<DocFormatDstrikeResult>> + Send + 'call

Set or clear the dstrike inline run property on the target text range.

Source

pub async fn dstrike_with_options( &self, params: &DocFormatDstrikeBoundParams, options: InvokeOptions, ) -> Result<DocFormatDstrikeResult>

Set or clear the dstrike inline run property on the target text range.

Source

pub fn east_asian_layout<'call>( &'call self, params: &'call DocFormatEastAsianLayoutBoundParams, ) -> impl Future<Output = Result<DocFormatEastAsianLayoutResult>> + Send + 'call

Set or clear the eastAsianLayout inline run property on the target text range.

Source

pub async fn east_asian_layout_with_options( &self, params: &DocFormatEastAsianLayoutBoundParams, options: InvokeOptions, ) -> Result<DocFormatEastAsianLayoutResult>

Set or clear the eastAsianLayout inline run property on the target text range.

Source

pub fn em<'call>( &'call self, params: &'call DocFormatEmBoundParams, ) -> impl Future<Output = Result<DocFormatEmResult>> + Send + 'call

Set or clear the em inline run property on the target text range.

Source

pub async fn em_with_options( &self, params: &DocFormatEmBoundParams, options: InvokeOptions, ) -> Result<DocFormatEmResult>

Set or clear the em inline run property on the target text range.

Source

pub fn emboss<'call>( &'call self, params: &'call DocFormatEmbossBoundParams, ) -> impl Future<Output = Result<DocFormatEmbossResult>> + Send + 'call

Set or clear the emboss inline run property on the target text range.

Source

pub async fn emboss_with_options( &self, params: &DocFormatEmbossBoundParams, options: InvokeOptions, ) -> Result<DocFormatEmbossResult>

Set or clear the emboss inline run property on the target text range.

Source

pub fn fit_text<'call>( &'call self, params: &'call DocFormatFitTextBoundParams, ) -> impl Future<Output = Result<DocFormatFitTextResult>> + Send + 'call

Set or clear the fitText inline run property on the target text range.

Source

pub async fn fit_text_with_options( &self, params: &DocFormatFitTextBoundParams, options: InvokeOptions, ) -> Result<DocFormatFitTextResult>

Set or clear the fitText inline run property on the target text range.

Source

pub fn font_family<'call>( &'call self, params: &'call DocFormatFontFamilyBoundParams, ) -> impl Future<Output = Result<DocFormatFontFamilyResult>> + Send + 'call

Set or clear the fontFamily inline run property on the target text range.

Source

pub async fn font_family_with_options( &self, params: &DocFormatFontFamilyBoundParams, options: InvokeOptions, ) -> Result<DocFormatFontFamilyResult>

Set or clear the fontFamily inline run property on the target text range.

Source

pub fn font_size<'call>( &'call self, params: &'call DocFormatFontSizeBoundParams, ) -> impl Future<Output = Result<DocFormatFontSizeResult>> + Send + 'call

Set or clear the fontSize inline run property on the target text range.

Source

pub async fn font_size_with_options( &self, params: &DocFormatFontSizeBoundParams, options: InvokeOptions, ) -> Result<DocFormatFontSizeResult>

Set or clear the fontSize inline run property on the target text range.

Source

pub fn font_size_cs<'call>( &'call self, params: &'call DocFormatFontSizeCsBoundParams, ) -> impl Future<Output = Result<DocFormatFontSizeCsResult>> + Send + 'call

Set or clear the fontSizeCs inline run property on the target text range.

Source

pub async fn font_size_cs_with_options( &self, params: &DocFormatFontSizeCsBoundParams, options: InvokeOptions, ) -> Result<DocFormatFontSizeCsResult>

Set or clear the fontSizeCs inline run property on the target text range.

Source

pub fn highlight<'call>( &'call self, params: &'call DocFormatHighlightBoundParams, ) -> impl Future<Output = Result<DocFormatHighlightResult>> + Send + 'call

Set or clear the highlight inline run property on the target text range.

Source

pub async fn highlight_with_options( &self, params: &DocFormatHighlightBoundParams, options: InvokeOptions, ) -> Result<DocFormatHighlightResult>

Set or clear the highlight inline run property on the target text range.

Source

pub fn i_cs<'call>( &'call self, params: &'call DocFormatICsBoundParams, ) -> impl Future<Output = Result<DocFormatICsResult>> + Send + 'call

Set or clear the iCs inline run property on the target text range.

Source

pub async fn i_cs_with_options( &self, params: &DocFormatICsBoundParams, options: InvokeOptions, ) -> Result<DocFormatICsResult>

Set or clear the iCs inline run property on the target text range.

Source

pub fn imprint<'call>( &'call self, params: &'call DocFormatImprintBoundParams, ) -> impl Future<Output = Result<DocFormatImprintResult>> + Send + 'call

Set or clear the imprint inline run property on the target text range.

Source

pub async fn imprint_with_options( &self, params: &DocFormatImprintBoundParams, options: InvokeOptions, ) -> Result<DocFormatImprintResult>

Set or clear the imprint inline run property on the target text range.

Source

pub fn italic<'call>( &'call self, params: &'call DocFormatItalicBoundParams, ) -> impl Future<Output = Result<DocFormatItalicResult>> + Send + 'call

Set or clear the italic inline run property on the target text range.

Source

pub async fn italic_with_options( &self, params: &DocFormatItalicBoundParams, options: InvokeOptions, ) -> Result<DocFormatItalicResult>

Set or clear the italic inline run property on the target text range.

Source

pub fn kerning<'call>( &'call self, params: &'call DocFormatKerningBoundParams, ) -> impl Future<Output = Result<DocFormatKerningResult>> + Send + 'call

Set or clear the kerning inline run property on the target text range.

Source

pub async fn kerning_with_options( &self, params: &DocFormatKerningBoundParams, options: InvokeOptions, ) -> Result<DocFormatKerningResult>

Set or clear the kerning inline run property on the target text range.

Source

pub fn lang<'call>( &'call self, params: &'call DocFormatLangBoundParams, ) -> impl Future<Output = Result<DocFormatLangResult>> + Send + 'call

Set or clear the lang inline run property on the target text range.

Source

pub async fn lang_with_options( &self, params: &DocFormatLangBoundParams, options: InvokeOptions, ) -> Result<DocFormatLangResult>

Set or clear the lang inline run property on the target text range.

Source

pub fn letter_spacing<'call>( &'call self, params: &'call DocFormatLetterSpacingBoundParams, ) -> impl Future<Output = Result<DocFormatLetterSpacingResult>> + Send + 'call

Set or clear the letterSpacing inline run property on the target text range.

Source

pub async fn letter_spacing_with_options( &self, params: &DocFormatLetterSpacingBoundParams, options: InvokeOptions, ) -> Result<DocFormatLetterSpacingResult>

Set or clear the letterSpacing inline run property on the target text range.

Source

pub fn ligatures<'call>( &'call self, params: &'call DocFormatLigaturesBoundParams, ) -> impl Future<Output = Result<DocFormatLigaturesResult>> + Send + 'call

Set or clear the ligatures inline run property on the target text range.

Source

pub async fn ligatures_with_options( &self, params: &DocFormatLigaturesBoundParams, options: InvokeOptions, ) -> Result<DocFormatLigaturesResult>

Set or clear the ligatures inline run property on the target text range.

Source

pub fn num_form<'call>( &'call self, params: &'call DocFormatNumFormBoundParams, ) -> impl Future<Output = Result<DocFormatNumFormResult>> + Send + 'call

Set or clear the numForm inline run property on the target text range.

Source

pub async fn num_form_with_options( &self, params: &DocFormatNumFormBoundParams, options: InvokeOptions, ) -> Result<DocFormatNumFormResult>

Set or clear the numForm inline run property on the target text range.

Source

pub fn num_spacing<'call>( &'call self, params: &'call DocFormatNumSpacingBoundParams, ) -> impl Future<Output = Result<DocFormatNumSpacingResult>> + Send + 'call

Set or clear the numSpacing inline run property on the target text range.

Source

pub async fn num_spacing_with_options( &self, params: &DocFormatNumSpacingBoundParams, options: InvokeOptions, ) -> Result<DocFormatNumSpacingResult>

Set or clear the numSpacing inline run property on the target text range.

Source

pub fn o_math<'call>( &'call self, params: &'call DocFormatOMathBoundParams, ) -> impl Future<Output = Result<DocFormatOMathResult>> + Send + 'call

Set or clear the oMath inline run property on the target text range.

Source

pub async fn o_math_with_options( &self, params: &DocFormatOMathBoundParams, options: InvokeOptions, ) -> Result<DocFormatOMathResult>

Set or clear the oMath inline run property on the target text range.

Source

pub fn outline<'call>( &'call self, params: &'call DocFormatOutlineBoundParams, ) -> impl Future<Output = Result<DocFormatOutlineResult>> + Send + 'call

Set or clear the outline inline run property on the target text range.

Source

pub async fn outline_with_options( &self, params: &DocFormatOutlineBoundParams, options: InvokeOptions, ) -> Result<DocFormatOutlineResult>

Set or clear the outline inline run property on the target text range.

Source

pub fn position<'call>( &'call self, params: &'call DocFormatPositionBoundParams, ) -> impl Future<Output = Result<DocFormatPositionResult>> + Send + 'call

Set or clear the position inline run property on the target text range.

Source

pub async fn position_with_options( &self, params: &DocFormatPositionBoundParams, options: InvokeOptions, ) -> Result<DocFormatPositionResult>

Set or clear the position inline run property on the target text range.

Source

pub fn read_selection<'call>( &'call self, params: &'call DocFormatReadSelectionBoundParams, ) -> impl Future<Output = Result<DocFormatReadSelectionResult>> + Send + 'call

Read inline formatting across a selection or caret, reporting each property as uniform, mixed, unset or unresolvable.

Source

pub async fn read_selection_with_options( &self, params: &DocFormatReadSelectionBoundParams, options: InvokeOptions, ) -> Result<DocFormatReadSelectionResult>

Read inline formatting across a selection or caret, reporting each property as uniform, mixed, unset or unresolvable.

Source

pub fn r_fonts<'call>( &'call self, params: &'call DocFormatRFontsBoundParams, ) -> impl Future<Output = Result<DocFormatRFontsResult>> + Send + 'call

Set or clear the rFonts inline run property on the target text range.

Source

pub async fn r_fonts_with_options( &self, params: &DocFormatRFontsBoundParams, options: InvokeOptions, ) -> Result<DocFormatRFontsResult>

Set or clear the rFonts inline run property on the target text range.

Source

pub fn r_style<'call>( &'call self, params: &'call DocFormatRStyleBoundParams, ) -> impl Future<Output = Result<DocFormatRStyleResult>> + Send + 'call

Set or clear the rStyle inline run property on the target text range.

Source

pub async fn r_style_with_options( &self, params: &DocFormatRStyleBoundParams, options: InvokeOptions, ) -> Result<DocFormatRStyleResult>

Set or clear the rStyle inline run property on the target text range.

Source

pub fn rtl<'call>( &'call self, params: &'call DocFormatRtlBoundParams, ) -> impl Future<Output = Result<DocFormatRtlResult>> + Send + 'call

Set or clear the rtl inline run property on the target text range. This does not change paragraph direction; use format.paragraph.setDirection for paragraph-level RTL.

Source

pub async fn rtl_with_options( &self, params: &DocFormatRtlBoundParams, options: InvokeOptions, ) -> Result<DocFormatRtlResult>

Set or clear the rtl inline run property on the target text range. This does not change paragraph direction; use format.paragraph.setDirection for paragraph-level RTL.

Source

pub fn shading<'call>( &'call self, params: &'call DocFormatShadingBoundParams, ) -> impl Future<Output = Result<DocFormatShadingResult>> + Send + 'call

Set or clear the shading inline run property on the target text range.

Source

pub async fn shading_with_options( &self, params: &DocFormatShadingBoundParams, options: InvokeOptions, ) -> Result<DocFormatShadingResult>

Set or clear the shading inline run property on the target text range.

Source

pub fn shadow<'call>( &'call self, params: &'call DocFormatShadowBoundParams, ) -> impl Future<Output = Result<DocFormatShadowResult>> + Send + 'call

Set or clear the shadow inline run property on the target text range.

Source

pub async fn shadow_with_options( &self, params: &DocFormatShadowBoundParams, options: InvokeOptions, ) -> Result<DocFormatShadowResult>

Set or clear the shadow inline run property on the target text range.

Source

pub fn small_caps<'call>( &'call self, params: &'call DocFormatSmallCapsBoundParams, ) -> impl Future<Output = Result<DocFormatSmallCapsResult>> + Send + 'call

Set or clear the smallCaps inline run property on the target text range.

Source

pub async fn small_caps_with_options( &self, params: &DocFormatSmallCapsBoundParams, options: InvokeOptions, ) -> Result<DocFormatSmallCapsResult>

Set or clear the smallCaps inline run property on the target text range.

Source

pub fn snap_to_grid<'call>( &'call self, params: &'call DocFormatSnapToGridBoundParams, ) -> impl Future<Output = Result<DocFormatSnapToGridResult>> + Send + 'call

Set or clear the snapToGrid inline run property on the target text range.

Source

pub async fn snap_to_grid_with_options( &self, params: &DocFormatSnapToGridBoundParams, options: InvokeOptions, ) -> Result<DocFormatSnapToGridResult>

Set or clear the snapToGrid inline run property on the target text range.

Source

pub fn spec_vanish<'call>( &'call self, params: &'call DocFormatSpecVanishBoundParams, ) -> impl Future<Output = Result<DocFormatSpecVanishResult>> + Send + 'call

Set or clear the specVanish inline run property on the target text range.

Source

pub async fn spec_vanish_with_options( &self, params: &DocFormatSpecVanishBoundParams, options: InvokeOptions, ) -> Result<DocFormatSpecVanishResult>

Set or clear the specVanish inline run property on the target text range.

Source

pub fn strike<'call>( &'call self, params: &'call DocFormatStrikeBoundParams, ) -> impl Future<Output = Result<DocFormatStrikeResult>> + Send + 'call

Set or clear the strike inline run property on the target text range.

Source

pub async fn strike_with_options( &self, params: &DocFormatStrikeBoundParams, options: InvokeOptions, ) -> Result<DocFormatStrikeResult>

Set or clear the strike inline run property on the target text range.

Source

pub fn stylistic_sets<'call>( &'call self, params: &'call DocFormatStylisticSetsBoundParams, ) -> impl Future<Output = Result<DocFormatStylisticSetsResult>> + Send + 'call

Set or clear the stylisticSets inline run property on the target text range.

Source

pub async fn stylistic_sets_with_options( &self, params: &DocFormatStylisticSetsBoundParams, options: InvokeOptions, ) -> Result<DocFormatStylisticSetsResult>

Set or clear the stylisticSets inline run property on the target text range.

Source

pub fn underline<'call>( &'call self, params: &'call DocFormatUnderlineBoundParams, ) -> impl Future<Output = Result<DocFormatUnderlineResult>> + Send + 'call

Set or clear the underline inline run property on the target text range.

Source

pub async fn underline_with_options( &self, params: &DocFormatUnderlineBoundParams, options: InvokeOptions, ) -> Result<DocFormatUnderlineResult>

Set or clear the underline inline run property on the target text range.

Source

pub fn vanish<'call>( &'call self, params: &'call DocFormatVanishBoundParams, ) -> impl Future<Output = Result<DocFormatVanishResult>> + Send + 'call

Set or clear the vanish inline run property on the target text range.

Source

pub async fn vanish_with_options( &self, params: &DocFormatVanishBoundParams, options: InvokeOptions, ) -> Result<DocFormatVanishResult>

Set or clear the vanish inline run property on the target text range.

Source

pub fn vert_align<'call>( &'call self, params: &'call DocFormatVertAlignBoundParams, ) -> impl Future<Output = Result<DocFormatVertAlignResult>> + Send + 'call

Set or clear the vertAlign inline run property on the target text range.

Source

pub async fn vert_align_with_options( &self, params: &DocFormatVertAlignBoundParams, options: InvokeOptions, ) -> Result<DocFormatVertAlignResult>

Set or clear the vertAlign inline run property on the target text range.

Source

pub fn web_hidden<'call>( &'call self, params: &'call DocFormatWebHiddenBoundParams, ) -> impl Future<Output = Result<DocFormatWebHiddenResult>> + Send + 'call

Set or clear the webHidden inline run property on the target text range.

Source

pub async fn web_hidden_with_options( &self, params: &DocFormatWebHiddenBoundParams, options: InvokeOptions, ) -> Result<DocFormatWebHiddenResult>

Set or clear the webHidden inline run property on the target text range.

Auto Trait Implementations§

§

impl<'a, I> Freeze for DocApiFormat<'a, I>
where &'a I: Freeze,

§

impl<'a, I> RefUnwindSafe for DocApiFormat<'a, I>

§

impl<'a, I> Send for DocApiFormat<'a, I>
where &'a I: Send,

§

impl<'a, I> Sync for DocApiFormat<'a, I>
where &'a I: Sync,

§

impl<'a, I> Unpin for DocApiFormat<'a, I>
where &'a I: Unpin,

§

impl<'a, I> UnsafeUnpin for DocApiFormat<'a, I>

§

impl<'a, I> UnwindSafe for DocApiFormat<'a, I>

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<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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.