CDPotion.Domain.IO (cdpotion v0.1.4)
Summary
Types
This is either obtained from another method or specified as blob:<uuid>
where
<uuid>
is an UUID of a Blob.
Functions
Close the stream, discard any temporary backing storage.
Read a chunk of the stream
Return UUID of Blob object specified by a remote object id.
Types
Link to this type
stream_handle()
@type stream_handle() :: String.t()
This is either obtained from another method or specified as blob:<uuid>
where
<uuid>
is an UUID of a Blob.
Functions
Link to this function
close(handle)
@spec close(stream_handle()) :: {String.t(), map()}
Close the stream, discard any temporary backing storage.
Parameters:
- (Required)
handle
: Handle of the stream to close.
Link to this function
read(handle, offset \\ nil, size \\ nil)
@spec read(stream_handle(), integer(), integer()) :: {String.t(), map()}
Read a chunk of the stream
Parameters:
- (Required)
handle
: Handle of the stream to read. - (Optional)
offset
: Seek to the specified offset before reading (if not specificed, proceed with offset following the last read). Some types of streams may only support sequential reads. - (Optional)
size
: Maximum number of bytes to read (left upon the agent discretion if not specified).
Link to this function
resolve_blob(object_id)
@spec resolve_blob(CDPotion.Domain.Runtime.remote_object_id()) :: {String.t(), map()}
Return UUID of Blob object specified by a remote object id.
Parameters:
- (Required)
object_id
: Object id of a Blob object wrapper.