boost::capy

Types

Name

Description

any_DynamicBuffer

An abstract, type‐erased dynamic buffer.

any_DynamicBuffer_impl

A type‐erased dynamic buffer.

any_executor

A type‐erased wrapper for executor objects.

application

A collection of type‐erased parts and process state

basic_string_buffer

A dynamic buffer using an underlying string

begin_mrdocs_workaround_t

Return an iterator pointing to the first element of a buffer sequence

buffer_size_mrdocs_workaround_t

Return the total number of bytes in a buffer sequence

circular_buffer

A circular buffer.

const_buffer

Holds a contiguous range of unmodifiable bytes

copy_mrdocs_workaround_t

Copy the contents of a buffer sequence into another buffer sequence

datastore

A polymorphic data container with clear functionality.

default_frame_allocator

A frame allocator that passes through to global new/delete.

default_handler

Default handler for run_async that discards results and rethrows exceptions.

end_mrdocs_workaround_t

Return an iterator to the end of the buffer sequence

execution_context

Base class for I/O object containers providing service management.

executor_ref

A type‐erased reference wrapper for executor objects.

executor_work_guard

RAII guard that keeps an executor's context from completing.

file

A platform‐independent file stream.

flat_buffer

A DynamicBuffer with a fixed capacity.

frame_allocating_base

Mixin base for promise types to support custom frame allocation.

front_mrdocs_workaround_t

Return the first buffer in a sequence.

get_executor_tag

Tag type for coroutine executor retrieval.

get_stop_token_tag

Tag type for coroutine stop token retrieval.

handler_pair

Combines two handlers into one: h1 for success, h2 for exception.

handler_pair<H1, default_handler>

Specialization for single handler that may handle both success and error.

has_rewind

Metafunction to determin if T::has_rewind exists.

has_rewind<T, std::void_t<decltype(std::declval<T&>().rewind())>>

has_size

Metafunction to determine if T::has_size exists.

has_size<T, std::void_t<void>>

io_awaitable_support

CRTP mixin that adds I/O awaitable support to a promise type.

is_DynamicBuffer

Metafunction to detect if a type is a dynamic buffer.

is_read_source

Metafunction to detect if a type is a read source.

is_read_source<T, std::void_t<void>>

keep_prefix_mrdocs_workaround_t

Remove all but the first n bytes from a buffer sequence

keep_suffix_mrdocs_workaround_t

Remove all but the last n bytes from a buffer sequence

mutable_buffer

Holds a contiguous range of modifiable bytes

polystore

A container of type‐erased objects

prefix_mrdocs_workaround_t

Return a sequence representing the first n bytes of a buffer sequence

remove_prefix_mrdocs_workaround_t

Remove n bytes from the beginning of a buffer sequence

remove_suffix_mrdocs_workaround_t

Remove n bytes from the end of a buffer sequence

run_async_wrapper

Wrapper returned by run_async that accepts a task for execution.

sans_prefix_mrdocs_workaround_t

Return a sequence representing all but the first n bytes of a buffer sequence

sans_suffix_mrdocs_workaround_t

Return a sequence representing all but the last n bytes of a buffer sequence

size_tag

size tag for tag_invoke

slice_of

slice_of<BufferSequence>

A wrapper enabling a buffer sequence to be consumed

slice_tag

slice tag for tag_invoke

strand

Provides serialized coroutine execution for any executor type.

suffix_mrdocs_workaround_t

Return a sequence representing the last n bytes of a buffer sequence

task

A coroutine task type implementing the affine awaitable protocol.

thread_pool

A pool of threads for executing work concurrently.

buffer_type

Alias for const_buffer or mutable_buffer depending on sequence type.

const_buffer_pair

A constant buffer pair

coro

Alias for a type‐erased coroutine handle

mutable_buffer_pair

A mutable buffer pair

slice_type

Alias for the type representing a slice of T

string_buffer

when_all_result_type

Enums

Name

Description

error

Error codes returned from algorithms and operations.

file_mode

File open modes

slice_how

slice constants for slice customization

Functions

Name

Description

buffer_length

Return the number of elements in a buffer sequence.

get_executor

Return a tag that yields the current executor when awaited.

get_stop_token

Return a tag that yields the current stop token when awaited.

invoke

Invoke a callable, injecting stored objects as arguments The callable is invoked with zero or more arguments. For each argument type, if an object of that type (or key type) is stored in the container, a reference to that object is passed to the callable.

make_any

make_buffer

Return a buffer.

make_error_code

make_work_guard

Create a work guard from an executor.

run_async

run_async overloads

run_on

Binds a task to execute on a specific executor.

tag_invoke

Remove a slice from the buffer

to_string

Convert a buffer sequence to a string

when_all

Wait for all tasks to complete concurrently.

Variables

Name

Description

begin

buffer_size

copy

end

front

keep_prefix

keep_suffix

prefix

range

Return a range representing the buffer sequence.

remove_prefix

remove_suffix

sans_prefix

sans_suffix

suffix

Concepts

Name

Description

ConstBufferSequence

Concept for types that model ConstBufferSequence.

DynamicBuffer

Concept for types that model DynamicBuffer.

Executor

Concept for executor types.

FrameAllocator

A concept for types that can allocate and deallocate coroutine frames.

IoAwaitable

Concept for I/O awaitable types.

IoAwaitableTask

Concept for I/O awaitable task types.

IoLaunchableTask

Concept for launchable I/O task types.

MutableBufferSequence

Concept for types that model MutableBufferSequence.

ReadStream

Concept for types that provide awaitable read operations.

Deduction Guides

Name

strand<Ex>

Created with MrDocs