boost::capy

Namespaces

Name

Description

this_coro

Namespace for coroutine environment accessors.

Types

Name

Description

any_executor

A type‐erased wrapper for executor objects.

async_event

An asynchronous event for coroutines.

async_mutex

An asynchronous mutex for coroutines.

basic_string_dynamic_buffer

A dynamic buffer using an underlying string

basic_vector_dynamic_buffer

A dynamic buffer using an underlying vector.

basic_vector_dynamic_buffer

A dynamic buffer using an underlying vector.

begin_mrdocs_workaround_t

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

buffer_copy_mrdocs_workaround_t

Copy the contents of a buffer sequence into another buffer sequence

buffer_empty_mrdocs_workaround_t

Check if a buffer sequence contains no data.

buffer_param

A buffer sequence wrapper providing windowed access.

buffer_param

A buffer sequence wrapper providing windowed access.

buffer_size_mrdocs_workaround_t

Return the total number of bytes in a buffer sequence

circular_dynamic_buffer

A fixed‐capacity circular buffer satisfying DynamicBuffer.

const_buffer

Holds a contiguous range of unmodifiable bytes

const_buffer_archetype_

Archetype for ConstBufferSequence concept checking.

consuming_buffers

Wrapper for consuming a buffer sequence incrementally.

consuming_buffers

Wrapper for consuming a buffer sequence incrementally.

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.

flat_dynamic_buffer

A fixed‐capacity linear buffer satisfying DynamicBuffer.

front_mrdocs_workaround_t

Return the first buffer in a sequence.

io_awaitable_support

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

io_result<>

Result type for void operations.

io_result

Result type for asynchronous I/O operations.

io_result<T1>

Result type for byte transfer operations.

io_result<T1, T2>

io_result<T1, T2, T3>

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

mutable_buffer_archetype_

Archetype for MutableBufferSequence concept checking.

prefix_mrdocs_workaround_t

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

recycling_memory_resource

Recycling memory resource with thread‐local and global pools.

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_archetype

const_buffer_pair

A constant buffer pair

coro

Alias for a type‐erased coroutine handle

mutable_buffer_archetype

mutable_buffer_pair

A mutable buffer pair

slice_type

Alias for the type representing a slice of T

string_dynamic_buffer

vector_dynamic_buffer

A dynamic buffer using std::vector<unsigned char>.

when_all_result_type

Enums

Name

Description

cond

Portable error conditions.

error

Error codes returned from algorithms and operations.

slice_how

slice constants for slice customization

Functions

Name

Description

buffer_length

Return the number of elements in a buffer sequence.

current_frame_allocator

Thread‐local storage for the current frame allocator.

get_recycling_memory_resource

Returns pointer to the default recycling memory resource.

get_system_context

Return the process‐wide system execution context.

make_buffer

make_buffer overloads

make_error_code

make_error_condition

make_work_guard

Create a work guard from an executor.

read

read overloads

run_async

run_async overloads

run_on

Binds a task to execute on a specific executor.

tag_invoke

Remove a slice from the buffer

when_all

Wait for all tasks to complete concurrently.

write

Write data until the buffer sequence is empty or an error occurs.

Concepts

Name

Description

ConstBufferSequence

Concept for types that model ConstBufferSequence.

DynamicBuffer

Concept for resizable buffer types with prepare/commit semantics.

DynamicBufferParam

Concept for valid DynamicBuffer parameter passing to coroutines.

Executor

Concept for executor types.

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.

ReadSource

Concept for types that provide awaitable read operations from a source.

ReadStream

Concept for types that provide awaitable read operations.

WriteSink

Concept for types that provide awaitable write operations to a sink.

WriteStream

Concept for types that provide awaitable write operations.

awaitable_decomposes_to

Concept for awaitables whose return type decomposes to a specific typelist.

decomposes_to

Concept for types that decompose to a specific typelist.

Deduction Guides

Using Declarations

Name

frame_memory_resource

Created with MrDocs