Struct DocApiBlocks 

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

Implementations

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

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

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

Delete an entire block node (paragraph, heading, list item, table, image, or sdt) deterministically.

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

Delete an entire block node (paragraph, heading, list item, table, image, or sdt) deterministically.

pub fn delete_range<'call>( &'call self, params: &'call DocBlocksDeleteRangeBoundParams, ) -> impl Future<Output = Result<DocBlocksDeleteRangeResult>> + Send + 'call

Delete a contiguous range of top-level blocks between two endpoints (inclusive). Both endpoints must be direct children of the document node. Supports dry-run preview.

pub async fn delete_range_with_options( &self, params: &DocBlocksDeleteRangeBoundParams, options: InvokeOptions, ) -> Result<DocBlocksDeleteRangeResult>

Delete a contiguous range of top-level blocks between two endpoints (inclusive). Both endpoints must be direct children of the document node. Supports dry-run preview.

pub fn find_text<'call>( &'call self, params: &'call DocBlocksFindTextBoundParams, ) -> impl Future<Output = Result<DocBlocksFindTextResult>> + Send + 'call

Find top-level body blocks containing a literal case-insensitive substring. Matches flattened block text, coalescing repeated hits and nested table paragraphs into one block. Scans at most 20,000 blocks inside the document host and returns compact previews without transferring full-text pages.

pub async fn find_text_with_options( &self, params: &DocBlocksFindTextBoundParams, options: InvokeOptions, ) -> Result<DocBlocksFindTextResult>

Find top-level body blocks containing a literal case-insensitive substring. Matches flattened block text, coalescing repeated hits and nested table paragraphs into one block. Scans at most 20,000 blocks inside the document host and returns compact previews without transferring full-text pages.

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

List top-level blocks in document order with IDs, types, text previews, and optional full text when includeText:true. Supports pagination via offset/limit after optional nodeTypes, nodeIds, and literal textSearch filtering, single-story scoping via in: <StoryLocator>, and final/original/redline projection of numbering metadata without changing block membership.

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

List top-level blocks in document order with IDs, types, text previews, and optional full text when includeText:true. Supports pagination via offset/limit after optional nodeTypes, nodeIds, and literal textSearch filtering, single-story scoping via in: <StoryLocator>, and final/original/redline projection of numbering metadata without changing block membership.

pub fn merge<'call>( &'call self, params: &'call DocBlocksMergeBoundParams, ) -> impl Future<Output = Result<DocBlocksMergeResult>> + Send + 'call

Merge two adjacent paragraphs in the same story. The first paragraph keeps its pPr; the second paragraph is removed. Rejects when either paragraph carries a w:sectPr or when their numbering definitions differ.

pub async fn merge_with_options( &self, params: &DocBlocksMergeBoundParams, options: InvokeOptions, ) -> Result<DocBlocksMergeResult>

Merge two adjacent paragraphs in the same story. The first paragraph keeps its pPr; the second paragraph is removed. Rejects when either paragraph carries a w:sectPr or when their numbering definitions differ.

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

Move a paragraph within the same story to a new anchor paragraph (before or after). Cross-story and relationship-bearing moves reject with named reasons. Tracked-mode authoring emits paired <w:moveFrom> / <w:moveTo> review state with explicit move range marker identity; safe content (no comment/bookmark/permission anchors and no pre-existing tracked wrappers) is required for tracked authoring.

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

Move a paragraph within the same story to a new anchor paragraph (before or after). Cross-story and relationship-bearing moves reject with named reasons. Tracked-mode authoring emits paired <w:moveFrom> / <w:moveTo> review state with explicit move range marker identity; safe content (no comment/bookmark/permission anchors and no pre-existing tracked wrappers) is required for tracked authoring.

pub fn split<'call>( &'call self, params: &'call DocBlocksSplitBoundParams, ) -> impl Future<Output = Result<DocBlocksSplitResult>> + Send + 'call

Split a paragraph at a visible-text offset, producing two paragraphs. Preserves unambiguous simple run properties around the cut. Rejects when the paragraph contains fields, content controls, drawings, equations, or unsupported tracked-change wrappers.

pub async fn split_with_options( &self, params: &DocBlocksSplitBoundParams, options: InvokeOptions, ) -> Result<DocBlocksSplitResult>

Split a paragraph at a visible-text offset, producing two paragraphs. Preserves unambiguous simple run properties around the cut. Rejects when the paragraph contains fields, content controls, drawings, equations, or unsupported tracked-change wrappers.