alist

Documentation

Index

• Constants
• func Login(ctx context.Context, host string, data LoginReq, opts ...LoginOpt) (string, error)
• type AlistResp
• type Client
  • func NewClient(host, token string, conf ...ClientConfig) (*Client, error)
  • func (c *Client) Do(req *http.Request) (*http.Response, error)
  • func (c *Client) FsGet(fSGetReq *FsGetReq) (*FsGetRespData, error)
  • func (c *Client) FsList(fSListReq *FsListReq) (*fsListResp, error)
  • func (c *Client) FsMkdir(fSMkdirReq *FsMkdirReq) error
  • func (c *Client) FsOther(fSOtherReq *FsOtherReq) (*fsOtherResp, error)
  • func (c *Client) FsRemove(fSRemoveReq *FsRemoveReq) error
  • func (c *Client) FsRename(fSRenameReq *FsRenameReq) error
  • func (c *Client) FsSearch(fSSearchReq *FsSearchReq) (*fsSearchResp, error)
  • func (c *Client) Login(data LoginReq, opts ...LoginOpt) error
  • func (c *Client) Me() (*meResp, error)
  • func (c *Client) NewRequest(method, relative string, data any) (req *http.Request, err error)
  • func (c *Client) SetToken(token string)
• type ClientConfig
  • func WithContext(ctx context.Context) ClientConfig
  • func WithUserAgent(userAgent string) ClientConfig
• type FsGetRelated
• type FsGetReq
• type FsGetResp
• type FsGetRespData
• type FsListReq
• type FsListResp
• type FsMkdirReq
• type FsMkdirResp
• type FsOtherReq
• type FsOtherResp
• type FsRemoveReq
• type FsRemoveResp
• type FsRenameReq
• type FsRenameResp
• type FsSearchReq
• type FsSearchResp
• type LoginOpt
  • func WithHashed() LoginOpt
• type LoginOptions
• type LoginReq
• type LoginResp
• type MeResp

Constants

const (
	FsOtherReqMethodVideoPreview = "video_preview"
)

Functions

func Login

func Login(ctx context.Context, host string, data LoginReq, opts ...LoginOpt) (string, error)

Types

type AlistResp

type AlistResp[T any] struct {
	Code    uint64 `json:"code"`
	Message string `json:"message"`
	Data    T      `json:"data"`
}

type Client

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

func NewClient

func NewClient(host, token string, conf ...ClientConfig) (*Client, error)

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)

func (*Client) FsGet

func (c *Client) FsGet(fSGetReq *FsGetReq) (*FsGetRespData, error)

func (*Client) FsList

func (c *Client) FsList(fSListReq *FsListReq) (*fsListResp, error)

func (*Client) FsMkdir

func (c *Client) FsMkdir(fSMkdirReq *FsMkdirReq) error

func (*Client) FsOther

func (c *Client) FsOther(fSOtherReq *FsOtherReq) (*fsOtherResp, error)

func (*Client) FsRemove

func (c *Client) FsRemove(fSRemoveReq *FsRemoveReq) error

func (*Client) FsRename

func (c *Client) FsRename(fSRenameReq *FsRenameReq) error

func (*Client) FsSearch

func (c *Client) FsSearch(fSSearchReq *FsSearchReq) (*fsSearchResp, error)

func (*Client) Login

func (c *Client) Login(data LoginReq, opts ...LoginOpt) error

func (*Client) Me

func (c *Client) Me() (*meResp, error)

func (*Client) NewRequest

func (c *Client) NewRequest(method, relative string, data any) (req *http.Request, err error)

func (*Client) SetToken

func (c *Client) SetToken(token string)

type ClientConfig

type ClientConfig func(*Client)

func WithContext

func WithContext(ctx context.Context) ClientConfig

func WithUserAgent

func WithUserAgent(userAgent string) ClientConfig

type FsGetRelated

type FsGetRelated struct {
	Name     string    `json:"name"`
	Size     uint64    `json:"size"`
	IsDir    bool      `json:"is_dir"`
	Modified time.Time `json:"modified"`
	Created  time.Time `json:"created"`
	Sign     string    `json:"sign"`
	Thumb    string    `json:"thumb"`
	Type     uint64    `json:"type"`
	Hashinfo string    `json:"hashinfo"`
}

type FsGetReq

type FsGetReq struct {
	Path     string `json:"path"`
	Password string `json:"password"`
}

type FsGetResp

type FsGetResp = AlistResp[FsGetRespData]

type FsGetRespData

type FsGetRespData struct {
	Name     string          `json:"name"`
	Size     uint64          `json:"size"`
	IsDir    bool            `json:"is_dir"`
	Modified time.Time       `json:"modified"`
	Created  time.Time       `json:"created"`
	Sign     string          `json:"sign"`
	Thumb    string          `json:"thumb"`
	Type     uint64          `json:"type"`
	Hashinfo string          `json:"hashinfo"`
	HashInfo any             `json:"hash_info"`
	RawURL   string          `json:"raw_url"`
	Readme   string          `json:"readme"`
	Provider string          `json:"provider"`
	Related  []*FsGetRelated `json:"related"`
}

type FsListReq

type FsListReq struct {
	Path     string `json:"path"`
	Password string `json:"password"`
	Page     uint64 `json:"page"`
	PerPage  uint64 `json:"per_page"`
	Refresh  bool   `json:"refresh"`
}

type FsListResp

type FsListResp = AlistResp[fsListResp]

type FsMkdirReq

type FsMkdirReq struct {
	Path string `json:"path"`
}

type FsMkdirResp

type FsMkdirResp = AlistResp[any]

type FsOtherReq

type FsOtherReq struct {
	Path     string `json:"path"`
	Method   string `json:"method"`
	Password string `json:"password"`
}

type FsOtherResp

type FsOtherResp = AlistResp[fsOtherResp]

type FsRemoveReq

type FsRemoveReq struct {
	Dir   bool     `json:"dir"`
	Names []string `json:"names"`
}

type FsRemoveResp

type FsRemoveResp = AlistResp[any]

type FsRenameReq

type FsRenameReq struct {
	Path string `json:"path"`
	Name string `json:"name"`
}

type FsRenameResp

type FsRenameResp = AlistResp[any]

type FsSearchReq

type FsSearchReq struct {
	Parent   string `json:"parent"`
	Keywords string `json:"keywords"`
	Scope    uint64 `json:"scope"`
	Page     uint64 `json:"page"`
	PerPage  uint64 `json:"per_page"`
	Password string `json:"password"`
}

type FsSearchResp

type FsSearchResp = AlistResp[fsSearchResp]

type LoginOpt

type LoginOpt func(*LoginOptions)

func WithHashed

func WithHashed() LoginOpt

type LoginOptions

type LoginOptions struct {
	Hashed bool
}

type LoginReq

type LoginReq struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

type LoginResp

type LoginResp = AlistResp[loginResp]

type MeResp

type MeResp = AlistResp[meResp]