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.

async_mutex

An asynchronous mutex for coroutines.

basic_string_dynamic_buffer

A dynamic buffer backed by a std::basic_string.

basic_vector_dynamic_buffer

A dynamic buffer using an underlying vector.

basic_vector_dynamic_buffer

A dynamic buffer using an underlying vector.

buffer_array

A buffer sequence holding up to N buffers.

buffer_param

A buffer sequence wrapper providing windowed access.

buffer_param

A buffer sequence wrapper providing windowed access.

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.

delay_awaitable

IoAwaitable returned by delay.

execution_context

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

executor_ref

A type‐erased reference wrapper for executor objects.

flat_dynamic_buffer

A fixed‐capacity linear buffer satisfying DynamicBuffer.

immediate

An awaitable that completes immediately with a value.

io_awaitable_promise_base

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

io_env

Execution environment for IoAwaitables.

io_result

Result type for asynchronous I/O operations.

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.

recycling_memory_resource

Recycling memory resource with size‐class buckets.

resume_via_post

Callable that posts a coroutine handle to an executor.

run_async_wrapper

Wrapper returned by run_async that accepts a task for execution.

size_tag

Tag type for customizing buffer_size via tag_invoke.

slice_of

slice_of<BufferSequence>

A view of a sub‐range of a buffer sequence.

slice_tag

Tag type for customizing slice operations via tag_invoke.

strand

Provides serialized coroutine execution for any executor type.

task

Lazy coroutine task satisfying IoRunnable.

thread_pool

A pool of threads for executing work concurrently.

work_guard

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

awaitable_result_t

The return type of co_await a for awaitable type A.

buffer_type

Alias for mutable_buffer or const_buffer based on sequence type.

const_buffer_archetype

const_buffer_array

Alias for buffer_array holding const_buffer.

const_buffer_pair

A constant buffer pair

const_buffer_param

Alias for buffer_param that always uses const_buffer storage.

io_task

A task type for I/O operations yielding io_result.

mutable_buffer_archetype

mutable_buffer_array

Alias for buffer_array holding mutable_buffer.

mutable_buffer_pair

A mutable buffer pair

slice_type

Alias for the type representing a slice of T

stop_resume_callback

Type alias for a stop callback that posts through the executor.

string_dynamic_buffer

A dynamic buffer using std::string.

vector_dynamic_buffer

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

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

begin

buffer_copy

buffer_empty

buffer_length

Return the number of buffer elements in a sequence.

buffer_size

delay

Suspend the current coroutine for a duration.

dynamic_buffer

dynamic_buffer overloads

end

front

front overloads

get

get_current_frame_allocator

Return the current frame allocator for this thread.

get_recycling_memory_resource

Returns pointer to the default recycling memory resource.

get_system_context

Return the process‐wide system execution context.

keep_prefix

keep_suffix

make_buffer

make_buffer overloads

make_error_code

Create an error_code from an error value.

make_error_condition

Create an error_condition from a cond value.

make_work_guard

Create a work guard from an executor.

prefix

pull_from

pull_from overloads

push_to

push_to overloads

read

read overloads

read_until

read_until overloads

ready

ready overloads

remove_prefix

remove_suffix

run

run overloads

run_async

run_async overloads

sans_prefix

sans_suffix

set_current_frame_allocator

Set the current frame allocator for this thread.

suffix

tag_invoke

tag_invoke overloads

timeout

Race an io_result‐returning awaitable against a deadline.

when_all

when_all overloads

when_any

when_any overloads

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.

IoAwaitableRange

Concept for ranges of I/O awaitables.

IoRunnable

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 providing complete reads from a data source.

ReadStream

Concept for types providing awaitable read operations.

Stream

Concept for types providing both read and write operations.

WriteSink

Concept for types providing complete writes with EOF signaling.

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

Name

buffer_param<BS>

strand<Ex>

Created with MrDocs