ObjectDescriptor is analogous to a file descriptor.
Applications use an ObjectDescriptor to perform multiple reads on the same Google Cloud Storage object.
Constructors
ObjectDescriptor(ObjectDescriptor &&)
Move-only.
| Parameter | |
|---|---|
| Name | Description |
|
ObjectDescriptor &&
|
ObjectDescriptor(ObjectDescriptor const &)
Move-only.
| Parameter | |
|---|---|
| Name | Description |
|
ObjectDescriptor const &
|
ObjectDescriptor()
Creates an uninitialized descriptor.
It is UB (undefined behavior) to use any functions on this descriptor.
ObjectDescriptor(std::shared_ptr< ObjectDescriptorConnection >)
Initialize a descriptor from its implementation class.
| Parameter | |
|---|---|
| Name | Description |
impl |
std::shared_ptr< ObjectDescriptorConnection >
|
Operators
operator=(ObjectDescriptor &&)
Move-only.
| Parameter | |
|---|---|
| Name | Description |
|
ObjectDescriptor &&
|
| Returns | |
|---|---|
| Type | Description |
ObjectDescriptor & |
|
operator=(ObjectDescriptor const &)
Move-only.
| Parameter | |
|---|---|
| Name | Description |
|
ObjectDescriptor const &
|
| Returns | |
|---|---|
| Type | Description |
ObjectDescriptor & |
|
Functions
metadata() const
Returns, if available, the object metadata associated with this descriptor.
| Returns | |
|---|---|
| Type | Description |
absl::optional< google::storage::v2::Object > |
|
Read(std::int64_t, std::int64_t)
Starts a new range read in the current descriptor.
| Parameters | |
|---|---|
| Name | Description |
offset |
std::int64_t
|
limit |
std::int64_t
|
| Returns | |
|---|---|
| Type | Description |
std::pair< AsyncReader, AsyncToken > |
|
ReadFromOffset(std::int64_t)
Starts a new read beginning at the supplied offset and continuing until the end.
| Parameter | |
|---|---|
| Name | Description |
offset |
std::int64_t
|
| Returns | |
|---|---|
| Type | Description |
std::pair< AsyncReader, AsyncToken > |
|
ReadLast(std::int64_t)
Reads the last number of bytes from the end.
| Parameter | |
|---|---|
| Name | Description |
limit |
std::int64_t
|
| Returns | |
|---|---|
| Type | Description |
std::pair< AsyncReader, AsyncToken > |
|
IsOpen() const
Returns true if the descriptor is open.
A descriptor is open if it has not been cancelled and has not hit a permanent failure.
| Returns | |
|---|---|
| Type | Description |
bool |
|