boost::capy

Namespaces

Name

Description

this_coro

Namespace for coroutine environment accessors.

Types

Name

Description

any_buffer_sink

Type‐erased wrapper for any BufferSink.

any_buffer_source

Type‐erased wrapper for any BufferSource.

any_executor

A type‐erased wrapper for executor objects.

any_read_source

Type‐erased wrapper for any ReadSource.

any_read_stream

Type‐erased wrapper for any ReadStream.

any_stream

Type‐erased wrapper for bidirectional streams.

any_write_sink

Type‐erased wrapper for any WriteSink.

any_write_stream

Type‐erased wrapper for any WriteStream.

async_event

An asynchronous event 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 to the first buffer in a 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 byte count across all buffers in a sequence.

circular_dynamic_buffer

A fixed‐capacity circular buffer satisfying DynamicBuffer.

const_buffer

A reference to a contiguous region of read‐only memory.

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.

coro_lock

An asynchronous mutex for coroutines.

end_mrdocs_workaround_t

Return an iterator past the last buffer in a 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.

immediate

An awaitable that completes immediately with a value.

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

match_delim

Match condition that searches for a delimiter string.

mutable_buffer

A reference to a contiguous region of writable memory.

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

Tag type for customizing buffer_size via tag_invoke.

slice_of

slice_of<BufferSequence>

A wrapper enabling a buffer sequence to be consumed

slice_tag

Tag type for customizing slice operations via tag_invoke.

some_const_buffers

A buffer sequence holding up to max_iovec_ const buffers.

some_mutable_buffers

A buffer sequence holding up to max_iovec_ mutable buffers.

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

Lazy coroutine task satisfying IoLaunchableTask.

thread_pool

A pool of threads for executing work concurrently.

buffer_type

Alias for mutable_buffer or const_buffer based on sequence type.

const_buffer_archetype

const_buffer_pair

A constant buffer pair

coro

Alias for a type‐erased coroutine handle

io_task

A task type for I/O operations yielding io_result.

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

Compute the result type of when_all for the given task types.

Enums

Name

Description

cond

Portable error conditions for capy I/O operations.

error

Error codes for capy I/O operations.

slice_how

Constants for slice customization.

Functions

Name

Description

buffer_length

Return the number of buffer elements in a sequence.

current_frame_allocator

Thread‐local storage for the current frame allocator.

dynamic_buffer

dynamic_buffer overloads

get_recycling_memory_resource

Returns pointer to the default recycling memory resource.

get_system_context

Return the process‐wide system execution context.

keep_span_prefix

keep_span_prefix overloads

keep_span_suffix

keep_span_suffix overloads

make_buffer

make_buffer overloads

make_error_code

make_error_condition

make_work_guard

Create a work guard from an executor.

pull_from

Transfer data from a ReadSource to a BufferSink.

push_to

Transfer data from a BufferSource to a WriteSink.

read

read overloads

read_until

read_until overloads

ready

ready overloads

remove_span_prefix

remove_span_prefix overloads

remove_span_suffix

remove_span_suffix overloads

run

run overloads

run_async

run_async overloads

tag_invoke

Slice customization point for tag_invoke.

when_all

Execute multiple tasks concurrently and collect their results.

write

Asynchronously write the entire buffer sequence.

Concepts

Name

Description

BufferSink

Concept for types that consume buffer data using callee‐owned buffers.

BufferSource

Concept for types that produce buffer data asynchronously.

ConstBufferSequence

Concept for sequences of read‐only buffer regions.

DynamicBuffer

Concept for resizable buffer types with prepare/commit semantics.

DynamicBufferParam

Concept for valid DynamicBuffer parameter passing to coroutines.

ExecutionContext

Concept for types that provide a place where work is executed.

Executor

Concept for types that schedule coroutine execution.

IoAwaitable

Concept for awaitables that participate in the I/O protocol.

IoAwaitableTask

Concept for task types with promise‐based context injection.

IoLaunchableTask

Concept for task types that can be launched from non‐coroutine contexts.

MatchCondition

Concept for callables that detect delimiters in streamed data.

MutableBufferSequence

Concept for sequences of writable buffer regions.

ReadSource

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

ReadStream

Concept for types providing awaitable read operations.

Stream

Concept for types providing both read and write 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