Skip to main content

DocApiImages

Struct DocApiImages 

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

Implementations§

Source§

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

Source

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

Source

pub fn convert_to_floating<'call>( &'call self, params: &'call DocImagesConvertToFloatingBoundParams, ) -> impl Future<Output = Result<DocImagesConvertToFloatingResult>> + Send + 'call

Convert an inline image to floating placement.

Source

pub async fn convert_to_floating_with_options( &self, params: &DocImagesConvertToFloatingBoundParams, options: InvokeOptions, ) -> Result<DocImagesConvertToFloatingResult>

Convert an inline image to floating placement.

Source

pub fn convert_to_inline<'call>( &'call self, params: &'call DocImagesConvertToInlineBoundParams, ) -> impl Future<Output = Result<DocImagesConvertToInlineResult>> + Send + 'call

Convert a floating image to inline placement.

Source

pub async fn convert_to_inline_with_options( &self, params: &DocImagesConvertToInlineBoundParams, options: InvokeOptions, ) -> Result<DocImagesConvertToInlineResult>

Convert a floating image to inline placement.

Source

pub fn crop<'call>( &'call self, params: &'call DocImagesCropBoundParams, ) -> impl Future<Output = Result<DocImagesCropResult>> + Send + 'call

Apply rectangular edge-percentage crop to an image.

Source

pub async fn crop_with_options( &self, params: &DocImagesCropBoundParams, options: InvokeOptions, ) -> Result<DocImagesCropResult>

Apply rectangular edge-percentage crop to an image.

Source

pub fn delete<'call>( &'call self, params: &'call DocImagesDeleteBoundParams, ) -> impl Future<Output = Result<DocImagesDeleteResult>> + Send + 'call

Delete an image from the document.

Source

pub async fn delete_with_options( &self, params: &DocImagesDeleteBoundParams, options: InvokeOptions, ) -> Result<DocImagesDeleteResult>

Delete an image from the document.

Source

pub fn flip<'call>( &'call self, params: &'call DocImagesFlipBoundParams, ) -> impl Future<Output = Result<DocImagesFlipResult>> + Send + 'call

Set horizontal and/or vertical flip state for an image.

Source

pub async fn flip_with_options( &self, params: &DocImagesFlipBoundParams, options: InvokeOptions, ) -> Result<DocImagesFlipResult>

Set horizontal and/or vertical flip state for an image.

Source

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

Get details for a specific image by its stable ID.

Source

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

Get details for a specific image by its stable ID.

Source

pub fn insert_caption<'call>( &'call self, params: &'call DocImagesInsertCaptionBoundParams, ) -> impl Future<Output = Result<DocImagesInsertCaptionResult>> + Send + 'call

Insert a caption paragraph below the image.

Source

pub async fn insert_caption_with_options( &self, params: &DocImagesInsertCaptionBoundParams, options: InvokeOptions, ) -> Result<DocImagesInsertCaptionResult>

Insert a caption paragraph below the image.

Source

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

List all images in the document.

Source

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

List all images in the document.

Source

pub fn move_<'call>( &'call self, params: &'call DocImagesMoveBoundParams, ) -> impl Future<Output = Result<DocImagesMoveResult>> + Send + 'call

Move an image to a new location in the document. Tracked-mode authoring supports safe sole inline-image body paragraphs and emits paired <w:moveFrom> / <w:moveTo> wrappers with explicit move range marker identity.

Source

pub async fn move_with_options( &self, params: &DocImagesMoveBoundParams, options: InvokeOptions, ) -> Result<DocImagesMoveResult>

Move an image to a new location in the document. Tracked-mode authoring supports safe sole inline-image body paragraphs and emits paired <w:moveFrom> / <w:moveTo> wrappers with explicit move range marker identity.

Source

pub fn remove_caption<'call>( &'call self, params: &'call DocImagesRemoveCaptionBoundParams, ) -> impl Future<Output = Result<DocImagesRemoveCaptionResult>> + Send + 'call

Remove the caption paragraph from below the image.

Source

pub async fn remove_caption_with_options( &self, params: &DocImagesRemoveCaptionBoundParams, options: InvokeOptions, ) -> Result<DocImagesRemoveCaptionResult>

Remove the caption paragraph from below the image.

Source

pub fn replace_source<'call>( &'call self, params: &'call DocImagesReplaceSourceBoundParams, ) -> impl Future<Output = Result<DocImagesReplaceSourceResult>> + Send + 'call

Replace the image source while preserving identity and placement.

Source

pub async fn replace_source_with_options( &self, params: &DocImagesReplaceSourceBoundParams, options: InvokeOptions, ) -> Result<DocImagesReplaceSourceResult>

Replace the image source while preserving identity and placement.

Source

pub fn reset_crop<'call>( &'call self, params: &'call DocImagesResetCropBoundParams, ) -> impl Future<Output = Result<DocImagesResetCropResult>> + Send + 'call

Remove all cropping from an image.

Source

pub async fn reset_crop_with_options( &self, params: &DocImagesResetCropBoundParams, options: InvokeOptions, ) -> Result<DocImagesResetCropResult>

Remove all cropping from an image.

Source

pub fn rotate<'call>( &'call self, params: &'call DocImagesRotateBoundParams, ) -> impl Future<Output = Result<DocImagesRotateResult>> + Send + 'call

Set the absolute rotation angle for an image.

Source

pub async fn rotate_with_options( &self, params: &DocImagesRotateBoundParams, options: InvokeOptions, ) -> Result<DocImagesRotateResult>

Set the absolute rotation angle for an image.

Source

pub fn scale<'call>( &'call self, params: &'call DocImagesScaleBoundParams, ) -> impl Future<Output = Result<DocImagesScaleResult>> + Send + 'call

Scale an image by a uniform factor applied to both dimensions.

Source

pub async fn scale_with_options( &self, params: &DocImagesScaleBoundParams, options: InvokeOptions, ) -> Result<DocImagesScaleResult>

Scale an image by a uniform factor applied to both dimensions.

Source

pub fn set_alt_text<'call>( &'call self, params: &'call DocImagesSetAltTextBoundParams, ) -> impl Future<Output = Result<DocImagesSetAltTextResult>> + Send + 'call

Set the accessibility description (alt text) for an image.

Source

pub async fn set_alt_text_with_options( &self, params: &DocImagesSetAltTextBoundParams, options: InvokeOptions, ) -> Result<DocImagesSetAltTextResult>

Set the accessibility description (alt text) for an image.

Source

pub fn set_anchor_options<'call>( &'call self, params: &'call DocImagesSetAnchorOptionsBoundParams, ) -> impl Future<Output = Result<DocImagesSetAnchorOptionsResult>> + Send + 'call

Set anchor behavior options for a floating image.

Source

pub async fn set_anchor_options_with_options( &self, params: &DocImagesSetAnchorOptionsBoundParams, options: InvokeOptions, ) -> Result<DocImagesSetAnchorOptionsResult>

Set anchor behavior options for a floating image.

Source

pub fn set_decorative<'call>( &'call self, params: &'call DocImagesSetDecorativeBoundParams, ) -> impl Future<Output = Result<DocImagesSetDecorativeResult>> + Send + 'call

Mark or unmark an image as decorative.

Source

pub async fn set_decorative_with_options( &self, params: &DocImagesSetDecorativeBoundParams, options: InvokeOptions, ) -> Result<DocImagesSetDecorativeResult>

Mark or unmark an image as decorative.

Set or remove the hyperlink attached to an image.

Set or remove the hyperlink attached to an image.

Source

pub fn set_lock_aspect_ratio<'call>( &'call self, params: &'call DocImagesSetLockAspectRatioBoundParams, ) -> impl Future<Output = Result<DocImagesSetLockAspectRatioResult>> + Send + 'call

Lock or unlock the aspect ratio for an image.

Source

pub async fn set_lock_aspect_ratio_with_options( &self, params: &DocImagesSetLockAspectRatioBoundParams, options: InvokeOptions, ) -> Result<DocImagesSetLockAspectRatioResult>

Lock or unlock the aspect ratio for an image.

Source

pub fn set_name<'call>( &'call self, params: &'call DocImagesSetNameBoundParams, ) -> impl Future<Output = Result<DocImagesSetNameResult>> + Send + 'call

Set the object name for an image.

Source

pub async fn set_name_with_options( &self, params: &DocImagesSetNameBoundParams, options: InvokeOptions, ) -> Result<DocImagesSetNameResult>

Set the object name for an image.

Source

pub fn set_position<'call>( &'call self, params: &'call DocImagesSetPositionBoundParams, ) -> impl Future<Output = Result<DocImagesSetPositionResult>> + Send + 'call

Set the anchor position for a floating image.

Source

pub async fn set_position_with_options( &self, params: &DocImagesSetPositionBoundParams, options: InvokeOptions, ) -> Result<DocImagesSetPositionResult>

Set the anchor position for a floating image.

Source

pub fn set_size<'call>( &'call self, params: &'call DocImagesSetSizeBoundParams, ) -> impl Future<Output = Result<DocImagesSetSizeResult>> + Send + 'call

Set explicit width/height for an image.

Source

pub async fn set_size_with_options( &self, params: &DocImagesSetSizeBoundParams, options: InvokeOptions, ) -> Result<DocImagesSetSizeResult>

Set explicit width/height for an image.

Source

pub fn set_wrap_distances<'call>( &'call self, params: &'call DocImagesSetWrapDistancesBoundParams, ) -> impl Future<Output = Result<DocImagesSetWrapDistancesResult>> + Send + 'call

Set the text-wrap distance margins for a floating image.

Source

pub async fn set_wrap_distances_with_options( &self, params: &DocImagesSetWrapDistancesBoundParams, options: InvokeOptions, ) -> Result<DocImagesSetWrapDistancesResult>

Set the text-wrap distance margins for a floating image.

Source

pub fn set_wrap_side<'call>( &'call self, params: &'call DocImagesSetWrapSideBoundParams, ) -> impl Future<Output = Result<DocImagesSetWrapSideResult>> + Send + 'call

Set which side(s) text wraps around a floating image.

Source

pub async fn set_wrap_side_with_options( &self, params: &DocImagesSetWrapSideBoundParams, options: InvokeOptions, ) -> Result<DocImagesSetWrapSideResult>

Set which side(s) text wraps around a floating image.

Source

pub fn set_wrap_type<'call>( &'call self, params: &'call DocImagesSetWrapTypeBoundParams, ) -> impl Future<Output = Result<DocImagesSetWrapTypeResult>> + Send + 'call

Set the text wrapping type for a floating image.

Source

pub async fn set_wrap_type_with_options( &self, params: &DocImagesSetWrapTypeBoundParams, options: InvokeOptions, ) -> Result<DocImagesSetWrapTypeResult>

Set the text wrapping type for a floating image.

Source

pub fn set_z_order<'call>( &'call self, params: &'call DocImagesSetZOrderBoundParams, ) -> impl Future<Output = Result<DocImagesSetZOrderResult>> + Send + 'call

Set the z-order (relativeHeight) for a floating image.

Source

pub async fn set_z_order_with_options( &self, params: &DocImagesSetZOrderBoundParams, options: InvokeOptions, ) -> Result<DocImagesSetZOrderResult>

Set the z-order (relativeHeight) for a floating image.

Source

pub fn update_caption<'call>( &'call self, params: &'call DocImagesUpdateCaptionBoundParams, ) -> impl Future<Output = Result<DocImagesUpdateCaptionResult>> + Send + 'call

Update the text of an existing caption paragraph.

Source

pub async fn update_caption_with_options( &self, params: &DocImagesUpdateCaptionBoundParams, options: InvokeOptions, ) -> Result<DocImagesUpdateCaptionResult>

Update the text of an existing caption paragraph.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

impl<'a, I> UnwindSafe for DocApiImages<'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.