Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type KillMessage ¶ added in v0.1.7
type KillMessage struct {
Status string `json:"status"`
}
KillMessage is a message noting that either the sidecar or the program should stop a KillMessage indicates the final message on a socket after which the connection can be broken
func NewKillMessage ¶ added in v0.1.7
func NewKillMessage() KillMessage
NewKillMessage creates a new default instance of KillMessage
func (*KillMessage) Deserialize ¶ added in v0.1.7
func (km *KillMessage) Deserialize(data []byte) (err error)
Deserialize tries to decode a json encoded byte array into `km`. Errors on failure
func (*KillMessage) Serialize ¶ added in v0.1.7
func (km *KillMessage) Serialize() (data []byte, err error)
Serialize tries to transform `km` into a json encoded bytearray. Errors on failure
type LocalFileDesc ¶
type LocalFileDesc struct {
Name string `json:"name"` // Original name as stored in the idv repository
LocalPath string `json:"path"` // Local path to file
}
LocalFileDesc is a description of an iterum data file downloaded and stored somewhere on the local volume
type LocalFragmentDesc ¶
type LocalFragmentDesc struct {
Files []LocalFileDesc `json:"files"`
}
LocalFragmentDesc is a structure describing an iterum fragment and how it is stored on the program's machine's local volume
func (*LocalFragmentDesc) Deserialize ¶
func (lf *LocalFragmentDesc) Deserialize(data []byte) (err error)
Deserialize tries to decode a json encoded byte array into `f`. Errors on failure
func (*LocalFragmentDesc) Serialize ¶
func (lf *LocalFragmentDesc) Serialize() (data []byte, err error)
Serialize tries to transform `f` into a json encoded bytearray. Errors on failure
type RemoteFileDesc ¶
type RemoteFileDesc struct {
Name string `json:"name"` // Original name as stored in the idv repository
RemotePath string `json:"path"` // Remote path to file within MinIO
Bucket string `json:"bucket"` // Name of the bucket that the file is stored in
}
RemoteFileDesc is a description of a file as found in the Minio storage
func (RemoteFileDesc) ToLocalPath ¶
func (rfd RemoteFileDesc) ToLocalPath(prefix string) string
ToLocalPath converts a RemoteFileDesc into a path on the local disk on where to store it
type RemoteFragmentDesc ¶
type RemoteFragmentDesc struct {
Files []RemoteFileDesc `json:"files"`
}
RemoteFragmentDesc is a structure describing an iterum fragment and how it is stored on the remote minio storage
func (*RemoteFragmentDesc) Deserialize ¶
func (rf *RemoteFragmentDesc) Deserialize(data []byte) (err error)
Deserialize tries to decode a json encoded byte array into `f`. Errors on failure
func (*RemoteFragmentDesc) Serialize ¶
func (rf *RemoteFragmentDesc) Serialize() (data []byte, err error)
Serialize tries to transform `f` into a json encoded bytearray. Errors on failure
Source Files