Base.show
— Function.show(x)
Write an informative text representation of a value to the current output stream. New types should overload show(io, x)
where the first argument is a stream. The representation used by show
generally includes Julia-specific formatting and type information.
show(io, mime, x)
The display
functions ultimately call show
in order to write an object x
as a given mime
type to a given I/O stream io
(usually a memory buffer), if possible. In order to provide a rich multimedia representation of a user-defined type T
, it is only necessary to define a new show
method for T
, via: show(io, ::MIME"mime", x::T) = ...
, where mime
is a MIME-type string and the function body calls write
(or similar) to write that representation of x
to io
. (Note that the MIME""
notation only supports literal strings; to construct MIME
types in a more flexible manner use MIME{Symbol("")}
.)
For example, if you define a MyImage
type and know how to write it to a PNG file, you could define a function show(io, ::MIME"image/png", x::MyImage) = ...
to allow your images to be displayed on any PNG-capable AbstractDisplay
(such as IJulia). As usual, be sure to import Base.show
in order to add new methods to the built-in Julia function show
.
The default MIME type is MIME"text/plain"
. There is a fallback definition for text/plain
output that calls show
with 2 arguments. Therefore, this case should be handled by defining a 2-argument show(io::IO, x::MyType)
method.
Technically, the MIME"mime"
macro defines a singleton type for the given mime
string, which allows us to exploit Julia's dispatch mechanisms in determining how to display objects of any given type.
The first argument to show
can be an IOContext
specifying output format properties. See IOContext
for details.
Genie.Router.Params
— Type.mutable struct Params{T}
Collection of key value pairs representing the parameters of the current request - response cycle.
Genie.Router.Route
— Type.mutable struct Route
Representation of a route object
Genie.Router.Channel
— Type.mutable struct Channel
Representation of a WebSocket Channel object
Missing docstring for Dict
. Check Documenter's build log for details.
Genie.Router.ispayload
— Function.ispayload(req::HTTP.Request)
True if the request can carry a payload - that is, it's a POST
, PUT
, or PATCH
request
Genie.Router.route
— Function.Named Genie routes constructors.
Genie.Router.channel
— Function.Named Genie channels constructors.
Genie.Router.namedroutes
— Function.The list of the defined named routes.
Genie.Router.namedchannels
— Function.named_channels() :: Dict{Symbol,Any}
The list of the defined named channels.
Genie.Router.routes
— Function.routes() :: Vector{Route}
Returns a vector of defined routes.
Genie.Router.channels
— Function.channels() :: Vector{Channel}
Returns a vector of defined channels.
Genie.Router.delete!
— Function.delete!(routes, route_name::Symbol)
Removes the route with the corresponding name from the routes collection and returns the collection of remaining routes.
Genie.Router.to_link!!
— Function.Generates the HTTP link corresponding to route_name
using the parameters in d
.
Generates the HTTP link corresponding to route_name
using the parameters in d
.
Generates the HTTP link corresponding to route_name
using the parameters in d
.
Generates the HTTP link corresponding to route_name
using the parameters in route_params
.
Genie.Router.link_to!!
— Function.Generates the HTTP link corresponding to route_name
using the parameters in d
.
Generates the HTTP link corresponding to route_name
using the parameters in d
.
Generates the HTTP link corresponding to route_name
using the parameters in d
.
Generates the HTTP link corresponding to route_name
using the parameters in route_params
.
Genie.Router.to_link
— Function.Generates the HTTP link corresponding to route_name
using the parameters in route_params
.
Genie.Router.link_to
— Function.Generates the HTTP link corresponding to route_name
using the parameters in route_params
.
Genie.Router.content_type
— Function.Genie.Router.content_length
— Function.Genie.Router.request_type_is
— Function.Genie.Router.request_type
— Function.Genie.Router.@params
— Macro.Genie.Router.@request
— Macro.Genie.Router.response_type
— Function.response_type{T}(params::Dict{Symbol,T}) :: Symbol
response_type(params::Params) :: Symbol
Returns the content-type of the current request-response cycle.
response_type{T}(check::Symbol, params::Dict{Symbol,T}) :: Bool
Checks if the content-type of the current request-response cycle matches check
.
Genie.Router.is_static_file
— Function.is_static_file(resource::String) :: Bool
Checks if the requested resource is a static file.
Genie.Router.to_uri
— Function.to_uri(resource::String) :: URI
Attempts to convert resource
to URI
Genie.Router.serve_static_file
— Function.serve_static_file(resource::String) :: Response
Reads the static file and returns the content as a Response
.
Genie.Router.preflight_response
— Function.Genie.Router.error_404
— Function.Genie.Router.error_500
— Function.Genie.Router.file_extension
— Function.file_extension(f) :: String
Returns the file extesion of f
.
Genie.Router.file_headers
— Function.file_headers(f) :: Dict{String,String}
Returns the file headers of f
.