api

package

v0.0.0-...-8fbeb48 Latest Latest Go to latest Published: Apr 7, 2024 License: AGPL-3.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	KeySize     = 16
	KeyHashSize = 32
)

This section is empty.

This section is empty.

type Client struct {
	// contains filtered or unexported fields
}

func NewClient(key Key) *Client

func (c *Client) Upload(uri string, extension string, encrypted bool, r io.Reader) (*UploadResponse, error)

type Key [KeySize]byte

func GenerateKey() (Key, error)

func ParseKey(keyString []byte) (Key, error)

func (k Key) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (k Key) String() string

String implements the fmt.Stringer interface.

func (k *Key) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

type KeyHash [KeyHashSize]byte

func HashKey(key Key) KeyHash

HashKey calculates a SHA-256 hash of the given key and returns it.

func ParseKeyHash(hashString []byte) (KeyHash, error)

func (h KeyHash) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (h KeyHash) String() string

String implements the fmt.Stringer interface.

func (h *KeyHash) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

type Response struct {
	Success bool            `json:"success"`
	Error   string          `json:"error"`
	Content json.RawMessage `json:"content"`
}

Response represents the base API response structure.

type UploadResponse struct {
	Filename string `json:"filename"`
}

UploadResponse represents the structure of an upload response.