mooncakes.io

api
→
client
→
detector
→
entity
→
oauth
→
testing
→
README
U
Account
U
Activity
U
Announcement
U
AppData
U
Application
U
AsyncAttachment
U
Attachment
U
AttachmentType
U
Card
U
Client
U
Context
U
Conversation
U
DirectoryOrder
U
Emoji
U
Endpoint
U
ExpandMedia
U
FeaturedTag
U
Field
U
Filter
U
FilterContext
U
FollowRequest
U
History
U
HttpMethod
U
HttpRequest
U
HttpResponse
U
IdentityProof
U
Instance
U
List
U
Marker
U
MarkerEntry
U
MegalodonError
U
Mention
U
MultipartBody
U
Notification
U
NotificationType
U
Pagination
U
ParamValue
U
Params
U
Poll
U
PollOption
U
PollOptions
U
Preferences
U
PushSubscription
U
Quote
U
QuoteApproval
U
QuoteState
U
QuotedStatus
U
Reaction
U
Relationship
U
Report
U
RequestBody
U
Response
U
Results
U
Role
U
ScheduledStatus
U
SearchType
U
ServerSoftware
U
ShallowQuote
U
Source
U
Stats
U
Status
U
StatusParams
U
StatusSource
U
StatusVisibility
U
Tag
U
Token
U
TokenData
U
Transport
U
URLs
U
UploadMedia
V
detector
V
generator

README

marianoguerra/megalodon/api does not have a README file

#
Transport

pub(open) trait Transport {
  async fn send(Self, HttpRequest) -> HttpResponse
  fn describe(Self) -> String
}

The portable seam between request construction and an HTTP implementation. Implementations should translate runtime/network failures to RequestFailed; status-code interpretation stays in the portable core.

#
MegalodonError

source

pub(all) suberror MegalodonError {
  InvalidRequest(String)
  RequestFailed(String)
  HttpStatus(status~ : Int, body~ : String, headers~ : Map[String, String])
  PartialContent(headers~ : Map[String, String])
  InvalidJson(String)
  InvalidEntity(entity~ : String, detail~ : String)
  UnknownServer(String)
  NodeInfo(String)
} derive(@moonbitlang/core/debug.Debug
Debug)

impl Show for MegalodonError

#
MegalodonError::describe_error

source

fn MegalodonError::describe_error(self : MegalodonError) -> String

#
MegalodonError::status

source

fn MegalodonError::status(self : MegalodonError) -> Int?

#
HttpMethod

source

pub(all) enum HttpMethod {
  Get
  Post
  Put
  Patch
  Delete
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

An HTTP method supported by the Mastodon-compatible REST API.

#
HttpMethod::to_string

source

fn HttpMethod::to_string(self : HttpMethod) -> String

#
HttpRequest

source

pub(all) struct HttpRequest {
  url : String
  http_method : HttpMethod
  headers : Map[String, String]
  body : Bytes
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A fully encoded outbound request. Transports must not reinterpret body.

#
HttpRequest::body_text

source

fn HttpRequest::body_text(self : HttpRequest) -> String

#
HttpRequest::content_length

source

fn HttpRequest::content_length(self : HttpRequest) -> Int

#
HttpResponse

source

pub(all) struct HttpResponse {
  status : Int
  headers : Map[String, String]
  body : Bytes
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

#
HttpResponse::body_text

source

fn HttpResponse::body_text(self : HttpResponse) -> String

#
HttpResponse::header

source

fn HttpResponse::header(self : HttpResponse, name : String) -> String?

#
MultipartBody

source

pub(all) struct MultipartBody {
  content_type : String
  body : Bytes
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

pub(all) struct Pagination {
  next : String?
  prev : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

#
ParamValue

source

pub(all) enum ParamValue {
  Str(String)
  Int(Int64)
  Bool(Bool)
  Strs(Array[String])
  Ints(Array[Int64])
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

#
Params

source

pub(all) struct Params {
  entries : Array[(String, ParamValue)]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Ordered parameters permit repeated keys and deterministic tests.

#
Params::encode

source

fn Params::encode(self : Params) -> String

#
Params::new

source

fn Params::new() -> Params

#
Params::of

source

fn Params::of(entries : Array[(String, ParamValue)]) -> Params

#
Params::put

source

fn Params::put(self : Params, key : String, value : ParamValue) -> Unit

#
Params::put_bool

source

fn Params::put_bool(self : Params, key : String, value : Bool?) -> Unit

#
Params::put_int

source

fn Params::put_int(self : Params, key : String, value : Int64?) -> Unit

#
Params::put_opt

source

fn Params::put_opt(self : Params, key : String, value : ParamValue?) -> Unit

#
Params::put_string

source

fn Params::put_string(self : Params, key : String, value : String?) -> Unit

#
Params::put_strings

source

fn Params::put_strings(self : Params, key : String, value : Array[String]?) -> Unit

#
RequestBody

source

pub(all) enum RequestBody {
  Empty
  Json(Json)
  Form(Params)
  Raw(bytes~ : Bytes, content_type~ : String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

#
Response

source

pub(all) struct Response[T] {
  data : T
  status : Int
  headers : Map[String, String]
  pagination : Pagination
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

#
Response::map

source

fn[A, B] Response::map(self : Response[A], f : (A) -> B) -> Response[B]

#
USER_AGENT

source

let USER_AGENT : String

#
build_request

source

fn build_request(base_url : String, path : String, http_method : HttpMethod, query? : Params, body? : RequestBody, access_token? : String, user_agent? : String, extra_headers? : Map[String, String]) -> HttpRequest

#
interpret

source

fn interpret(response : HttpResponse) -> Response[Json] raise MegalodonError

#
multipart_file

source

fn multipart_file(boundary : String, field_name : String, file_name : String, mime_type : String, bytes : Bytes, fields? : Array[(String, String)]) -> MultipartBody raise MegalodonError

Build a deterministic multipart/form-data body without filesystem or clock access, keeping media upload available on every target.

#
pagination_from_headers

source

fn pagination_from_headers(headers : Map[String, String]) -> Pagination

#
percent_encode

source

fn percent_encode(text : String) -> String

RFC 3986 percent-encoding over UTF-8 bytes.

#
to_megalodon_error

source

fn to_megalodon_error(error : Error) -> MegalodonError

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Transport

#MegalodonError

#MegalodonError::describe_error

#MegalodonError::status

#HttpMethod

#HttpMethod::to_string

#HttpRequest

#HttpRequest::body_text

#HttpRequest::content_length

#HttpResponse

#HttpResponse::body_text

#HttpResponse::header

#MultipartBody

#Pagination

#ParamValue

#Params

#Params::encode

#Params::new

#Params::of

#Params::put

#Params::put_bool

#Params::put_int

#Params::put_opt

#Params::put_string

#Params::put_strings

#RequestBody

#Response

#Response::map

#USER_AGENT

#build_request

#interpret

#multipart_file

#pagination_from_headers

#percent_encode

#to_megalodon_error

Source Files

#
Transport

#
MegalodonError

#
MegalodonError::describe_error

#
MegalodonError::status

#
HttpMethod

#
HttpMethod::to_string

#
HttpRequest

#
HttpRequest::body_text

#
HttpRequest::content_length

#
HttpResponse

#
HttpResponse::body_text

#
HttpResponse::header

#
MultipartBody

#
Pagination

#
ParamValue

#
Params

#
Params::encode

#
Params::new

#
Params::of

#
Params::put

#
Params::put_bool

#
Params::put_int

#
Params::put_opt

#
Params::put_string

#
Params::put_strings

#
RequestBody

#
Response

#
Response::map

#
USER_AGENT

#
build_request

#
interpret

#
multipart_file

#
pagination_from_headers

#
percent_encode

#
to_megalodon_error