The options for read operations. More...

#include <opendal.h>

Public Attributes
uint64_t	offset
bool	has_length
uint64_t	length
const char *	version
const char *	if_match
const char *	if_none_match
bool	has_if_modified_since
int64_t	if_modified_since
bool	has_if_unmodified_since
int64_t	if_unmodified_since
uintptr_t	concurrent
bool	has_chunk
uintptr_t	chunk
bool	has_gap
uintptr_t	gap
bool	has_content_length_hint
uint64_t	content_length_hint
const char *	override_content_type
const char *	override_cache_control
const char *	override_content_disposition

Detailed Description

The options for read operations.

Use opendal_read_options_new() to construct and opendal_read_options_free() to free.

Member Data Documentation

◆ chunk

uintptr_t opendal_read_options::chunk

Chunk size for each read request.

◆ concurrent

uintptr_t opendal_read_options::concurrent

Concurrent read operations. 0 means sequential reads.

◆ content_length_hint

uint64_t opendal_read_options::content_length_hint

Known content length of the object, used as an execution hint to avoid extra metadata requests while planning reads.

◆ gap

uintptr_t opendal_read_options::gap

Gap size for merging nearby range reads.

◆ has_chunk

bool opendal_read_options::has_chunk

Whether chunk has been set.

◆ has_content_length_hint

bool opendal_read_options::has_content_length_hint

Whether content_length_hint has been set.

◆ has_gap

bool opendal_read_options::has_gap

Whether gap has been set.

◆ has_if_modified_since

bool opendal_read_options::has_if_modified_since

Whether if_modified_since has been set.

◆ has_if_unmodified_since

bool opendal_read_options::has_if_unmodified_since

Whether if_unmodified_since has been set.

◆ has_length

bool opendal_read_options::has_length

Whether length has been set.

◆ if_match

const char* opendal_read_options::if_match

If-Match header value; NULL means unset.

◆ if_modified_since

int64_t opendal_read_options::if_modified_since

If-Modified-Since condition, in Unix milliseconds.

◆ if_none_match

const char* opendal_read_options::if_none_match

If-None-Match header value; NULL means unset.

◆ if_unmodified_since

int64_t opendal_read_options::if_unmodified_since

If-Unmodified-Since condition, in Unix milliseconds.

◆ length

uint64_t opendal_read_options::length

The number of bytes to read starting from offset.

◆ offset

uint64_t opendal_read_options::offset

The start offset of the range to read; default 0.

◆ override_cache_control

const char* opendal_read_options::override_cache_control

Override the response Cache-Control header (presign only); NULL means unset.

◆ override_content_disposition

const char* opendal_read_options::override_content_disposition

Override the response Content-Disposition header (presign only); NULL means unset.

◆ override_content_type

const char* opendal_read_options::override_content_type

Override the response Content-Type header (presign only); NULL means unset.

◆ version

const char* opendal_read_options::version

The version of the object to read; NULL means unset.

The documentation for this struct was generated from the following file:

include/opendal.h

Public Attributes