Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Exported types
- Methods
- build
- buildWithUser
- errorQuark
- escapeBytes
- escapeString
- getAuthParams
- getFlags
- getFragment
- getHost
- getPassword
- getPath
- getPort
- getQuery
- getScheme
- getUser
- getUserinfo
- isValid
- join
- joinWithUser
- listExtractUris
- parse
- parseParams
- parseRelative
- parseScheme
- peekScheme
- resolveRelative
- split
- splitNetwork
- splitWithUser
- toString
- toStringPartial
- unescapeBytes
- unescapeSegment
- unescapeString
The Uri
type and related functions can be used to parse URIs into
their components, and build valid URIs from individual components.
Note that Uri
scope is to help manipulate URIs in various applications,
following RFC 3986. In particular,
it doesn't intend to cover web browser needs, and doesn't implement the
WHATWG URL standard. No APIs are provided to
help prevent
homograph attacks, so
Uri
is not suitable for formatting URIs for display to the user for making
security-sensitive decisions.
## Relative and absolute URIs # {relative
-absolute-uris}
As defined in RFC 3986, the hierarchical nature of URIs means that they can either be ‘relative references’ (sometimes referred to as ‘relative URIs’) or ‘URIs’ (for clarity, ‘URIs’ are referred to in this documentation as ‘absolute URIs’ — although in constrast to RFC 3986, fragment identifiers are always allowed).
Relative references have one or more components of the URI missing. In
particular, they have no scheme. Any other component, such as hostname,
query, etc. may be missing, apart from a path, which has to be specified (but
may be empty). The path may be relative, starting with ./
rather than /
.
For example, a valid relative reference is ./path?query
,
/?query#fragment
or //example.com
.
Absolute URIs have a scheme specified. Any other components of the URI which
are missing are specified as explicitly unset in the URI, rather than being
resolved relative to a base URI using uriParseRelative
.
For example, a valid absolute URI is file:///home/bob
or
https://search.com?query=string
.
A Uri
instance is always an absolute URI. A string may be an absolute URI
or a relative reference; see the documentation for individual functions as to
what forms they accept.
Parsing URIs
The most minimalist APIs for parsing URIs are uriSplit
and
uriSplitWithUser
. These split a URI into its component
parts, and return the parts; the difference between the two is that
uriSplit
treats the ‘userinfo’ component of the URI as a
single element, while uriSplitWithUser
can (depending on the
UriFlags
you pass) treat it as containing a username, password,
and authentication parameters. Alternatively, uriSplitNetwork
can be used when you are only interested in the components that are
needed to initiate a network connection to the service (scheme,
host, and port).
uriParse
is similar to uriSplit
, but instead of returning
individual strings, it returns a Uri
structure (and it requires
that the URI be an absolute URI).
uriResolveRelative
and uriParseRelative
allow you to
resolve a relative URI relative to a base URI.
uriResolveRelative
takes two strings and returns a string,
and uriParseRelative
takes a Uri
and a string and returns a
Uri
.
All of the parsing functions take a UriFlags
argument describing
exactly how to parse the URI; see the documentation for that type
for more details on the specific flags that you can pass. If you
need to choose different flags based on the type of URI, you can
use uriPeekScheme
on the URI string to check the scheme
first, and use that to decide what flags to parse it with.
For example, you might want to use UriParamsFlagsWwwForm
when parsing the
params for a web URI, so compare the result of uriPeekScheme
against
http
and https
.
Building URIs
uriJoin
and uriJoinWithUser
can be used to construct
valid URI strings from a set of component strings. They are the
inverse of uriSplit
and uriSplitWithUser
.
Similarly, uriBuild
and uriBuildWithUser
can be used to
construct a Uri
from a set of component strings.
As with the parsing functions, the building functions take a
UriFlags
argument. In particular, it is important to keep in mind
whether the URI components you are using are already %
-encoded. If so,
you must pass the UriFlagsEncoded
flag.
file://
URIs
Note that Windows and Unix both define special rules for parsing
file://
URIs (involving non-UTF-8 character sets on Unix, and the
interpretation of path separators on Windows). Uri
does not
implement these rules. Use filenameFromUri
and
filenameToUri
if you want to properly convert between
file://
URIs and local filenames.
URI Equality
Note that there is no g_uri_equal ()
function, because comparing
URIs usefully requires scheme-specific knowledge that Uri
does
not have. For example, http://example.com/
and
http://EXAMPLE.COM:80
have exactly the same meaning according
to the HTTP specification, and data:,foo
and
data:;base64,Zm9v
resolve to the same thing according to the
data:
URI specification.
Since: 2.66
Synopsis
- newtype Uri = Uri (ManagedPtr Uri)
- uriBuild :: (HasCallStack, MonadIO m) => [UriFlags] -> Text -> Maybe Text -> Maybe Text -> Int32 -> Text -> Maybe Text -> Maybe Text -> m Uri
- uriBuildWithUser :: (HasCallStack, MonadIO m) => [UriFlags] -> Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Int32 -> Text -> Maybe Text -> Maybe Text -> m Uri
- uriErrorQuark :: (HasCallStack, MonadIO m) => m Word32
- uriEscapeBytes :: (HasCallStack, MonadIO m) => ByteString -> Maybe Text -> m Text
- uriEscapeString :: (HasCallStack, MonadIO m) => Text -> Maybe Text -> Bool -> m Text
- uriGetAuthParams :: (HasCallStack, MonadIO m) => Uri -> m (Maybe Text)
- uriGetFlags :: (HasCallStack, MonadIO m) => Uri -> m [UriFlags]
- uriGetFragment :: (HasCallStack, MonadIO m) => Uri -> m (Maybe Text)
- uriGetHost :: (HasCallStack, MonadIO m) => Uri -> m Text
- uriGetPassword :: (HasCallStack, MonadIO m) => Uri -> m (Maybe Text)
- uriGetPath :: (HasCallStack, MonadIO m) => Uri -> m Text
- uriGetPort :: (HasCallStack, MonadIO m) => Uri -> m Int32
- uriGetQuery :: (HasCallStack, MonadIO m) => Uri -> m (Maybe Text)
- uriGetScheme :: (HasCallStack, MonadIO m) => Uri -> m Text
- uriGetUser :: (HasCallStack, MonadIO m) => Uri -> m (Maybe Text)
- uriGetUserinfo :: (HasCallStack, MonadIO m) => Uri -> m (Maybe Text)
- uriIsValid :: (HasCallStack, MonadIO m) => Text -> [UriFlags] -> m ()
- uriJoin :: (HasCallStack, MonadIO m) => [UriFlags] -> Maybe Text -> Maybe Text -> Maybe Text -> Int32 -> Text -> Maybe Text -> Maybe Text -> m Text
- uriJoinWithUser :: (HasCallStack, MonadIO m) => [UriFlags] -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Int32 -> Text -> Maybe Text -> Maybe Text -> m Text
- uriListExtractUris :: (HasCallStack, MonadIO m) => Text -> m [Text]
- uriParse :: (HasCallStack, MonadIO m) => Text -> [UriFlags] -> m Uri
- uriParseParams :: (HasCallStack, MonadIO m) => Text -> Int64 -> Text -> [UriParamsFlags] -> m (Map Text Text)
- uriParseRelative :: (HasCallStack, MonadIO m) => Uri -> Text -> [UriFlags] -> m Uri
- uriParseScheme :: (HasCallStack, MonadIO m) => Text -> m (Maybe Text)
- uriPeekScheme :: (HasCallStack, MonadIO m) => Text -> m (Maybe Text)
- uriResolveRelative :: (HasCallStack, MonadIO m) => Maybe Text -> Text -> [UriFlags] -> m Text
- uriSplit :: (HasCallStack, MonadIO m) => Text -> [UriFlags] -> m (Maybe Text, Maybe Text, Maybe Text, Int32, Text, Maybe Text, Maybe Text)
- uriSplitNetwork :: (HasCallStack, MonadIO m) => Text -> [UriFlags] -> m (Maybe Text, Maybe Text, Int32)
- uriSplitWithUser :: (HasCallStack, MonadIO m) => Text -> [UriFlags] -> m (Maybe Text, Maybe Text, Maybe Text, Maybe Text, Maybe Text, Int32, Text, Maybe Text, Maybe Text)
- uriToString :: (HasCallStack, MonadIO m) => Uri -> m Text
- uriToStringPartial :: (HasCallStack, MonadIO m) => Uri -> [UriHideFlags] -> m Text
- uriUnescapeBytes :: (HasCallStack, MonadIO m) => Text -> Int64 -> Maybe Text -> m Bytes
- uriUnescapeSegment :: (HasCallStack, MonadIO m) => Maybe Text -> Maybe Text -> Maybe Text -> m Text
- uriUnescapeString :: (HasCallStack, MonadIO m) => Text -> Maybe Text -> m Text
Exported types
Memory-managed wrapper type.
Instances
Eq Uri Source # | |
GBoxed Uri Source # | |
Defined in GI.GLib.Structs.Uri | |
ManagedPtrNewtype Uri Source # | |
Defined in GI.GLib.Structs.Uri toManagedPtr :: Uri -> ManagedPtr Uri | |
TypedObject Uri Source # | |
Defined in GI.GLib.Structs.Uri | |
HasParentTypes Uri Source # | |
Defined in GI.GLib.Structs.Uri | |
IsGValue (Maybe Uri) Source # | Convert |
Defined in GI.GLib.Structs.Uri gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Uri -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Uri) | |
type ParentTypes Uri Source # | |
Defined in GI.GLib.Structs.Uri |
Methods
Click to display all available methods, including inherited ones
Methods
parseRelative, toString, toStringPartial.
Getters
getAuthParams, getFlags, getFragment, getHost, getPassword, getPath, getPort, getQuery, getScheme, getUser, getUserinfo.
Setters
None.
build
:: (HasCallStack, MonadIO m) | |
=> [UriFlags] |
|
-> Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> Int32 |
|
-> Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> m Uri | Returns: a new |
Creates a new Uri
from the given components according to flags
.
See also uriBuildWithUser
, which allows specifying the
components of the "userinfo" separately.
Since: 2.66
buildWithUser
:: (HasCallStack, MonadIO m) | |
=> [UriFlags] |
|
-> Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> Int32 |
|
-> Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> m Uri | Returns: a new |
Creates a new Uri
from the given components according to flags
(UriFlagsHasPassword
is added unconditionally). The flags
must be
coherent with the passed values, in particular use %
-encoded values with
UriFlagsEncoded
.
In contrast to uriBuild
, this allows specifying the components
of the ‘userinfo’ field separately. Note that user
must be non-Nothing
if either password
or authParams
is non-Nothing
.
Since: 2.66
errorQuark
uriErrorQuark :: (HasCallStack, MonadIO m) => m Word32 Source #
No description available in the introspection data.
escapeBytes
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> Maybe Text |
|
-> m Text | Returns: an escaped version of |
Escapes arbitrary data for use in a URI.
Normally all characters that are not ‘unreserved’ (i.e. ASCII
alphanumerical characters plus dash, dot, underscore and tilde) are
escaped. But if you specify characters in reservedCharsAllowed
they are not escaped. This is useful for the ‘reserved’ characters
in the URI specification, since those are allowed unescaped in some
portions of a URI.
Though technically incorrect, this will also allow escaping nul
bytes as %
00
.
Since: 2.66
escapeString
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> Maybe Text |
|
-> Bool |
|
-> m Text | Returns: an escaped version of |
Escapes a string for use in a URI.
Normally all characters that are not "unreserved" (i.e. ASCII
alphanumerical characters plus dash, dot, underscore and tilde) are
escaped. But if you specify characters in reservedCharsAllowed
they are not escaped. This is useful for the "reserved" characters
in the URI specification, since those are allowed unescaped in some
portions of a URI.
Since: 2.16
getAuthParams
:: (HasCallStack, MonadIO m) | |
=> Uri |
|
-> m (Maybe Text) | Returns: |
Gets uri
's authentication parameters, which may contain
%
-encoding, depending on the flags with which uri
was created.
(If uri
was not created with UriFlagsHasAuthParams
then this will
be Nothing
.)
Depending on the URI scheme, uriParseParams
may be useful for
further parsing this information.
Since: 2.66
getFlags
:: (HasCallStack, MonadIO m) | |
=> Uri |
|
-> m [UriFlags] | Returns: |
Gets uri
's flags set upon construction.
Since: 2.66
getFragment
Gets uri
's fragment, which may contain %
-encoding, depending on
the flags with which uri
was created.
Since: 2.66
getHost
:: (HasCallStack, MonadIO m) | |
=> Uri |
|
-> m Text | Returns: |
Gets uri
's host. This will never have %
-encoded characters,
unless it is non-UTF-8 (which can only be the case if uri
was
created with UriFlagsNonDns
).
If uri
contained an IPv6 address literal, this value will be just
that address, without the brackets around it that are necessary in
the string form of the URI. Note that in this case there may also
be a scope ID attached to the address. Eg, fe80::1234%
em1
(or
fe80::1234%
25em1
if the string is still encoded).
Since: 2.66
getPassword
Gets uri
's password, which may contain %
-encoding, depending on
the flags with which uri
was created. (If uri
was not created
with UriFlagsHasPassword
then this will be Nothing
.)
Since: 2.66
getPath
:: (HasCallStack, MonadIO m) | |
=> Uri |
|
-> m Text | Returns: |
Gets uri
's path, which may contain %
-encoding, depending on the
flags with which uri
was created.
Since: 2.66
getPort
:: (HasCallStack, MonadIO m) | |
=> Uri |
|
-> m Int32 | Returns: |
Gets uri
's port.
Since: 2.66
getQuery
Gets uri
's query, which may contain %
-encoding, depending on the
flags with which uri
was created.
For queries consisting of a series of name=value
parameters,
UriParamsIter
or uriParseParams
may be useful.
Since: 2.66
getScheme
:: (HasCallStack, MonadIO m) | |
=> Uri |
|
-> m Text | Returns: |
Gets uri
's scheme. Note that this will always be all-lowercase,
regardless of the string or strings that uri
was created from.
Since: 2.66
getUser
Gets the ‘username’ component of uri
's userinfo, which may contain
%
-encoding, depending on the flags with which uri
was created.
If uri
was not created with UriFlagsHasPassword
or
UriFlagsHasAuthParams
, this is the same as uriGetUserinfo
.
Since: 2.66
getUserinfo
Gets uri
's userinfo, which may contain %
-encoding, depending on
the flags with which uri
was created.
Since: 2.66
isValid
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> [UriFlags] |
|
-> m () | (Can throw |
Parses uriString
according to flags
, to determine whether it is a valid
[absolute URI][relative-absolute-uris], i.e. it does not need to be resolved
relative to another URI using uriParseRelative
.
If it’s not a valid URI, an error is returned explaining how it’s invalid.
See uriSplit
, and the definition of UriFlags
, for more
information on the effect of flags
.
Since: 2.66
join
:: (HasCallStack, MonadIO m) | |
=> [UriFlags] |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> Int32 |
|
-> Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> m Text | Returns: an absolute URI string |
Joins the given components together according to flags
to create
an absolute URI string. path
may not be Nothing
(though it may be the empty
string).
When host
is present, path
must either be empty or begin with a slash (/
)
character. When host
is not present, path
cannot begin with two slash
characters (//
). See
RFC 3986, section 3.
See also uriJoinWithUser
, which allows specifying the
components of the ‘userinfo’ separately.
UriFlagsHasPassword
and UriFlagsHasAuthParams
are ignored if set
in flags
.
Since: 2.66
joinWithUser
:: (HasCallStack, MonadIO m) | |
=> [UriFlags] |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> Int32 |
|
-> Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> m Text | Returns: an absolute URI string |
Joins the given components together according to flags
to create
an absolute URI string. path
may not be Nothing
(though it may be the empty
string).
In contrast to uriJoin
, this allows specifying the components
of the ‘userinfo’ separately. It otherwise behaves the same.
UriFlagsHasPassword
and UriFlagsHasAuthParams
are ignored if set
in flags
.
Since: 2.66
listExtractUris
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m [Text] | Returns: a newly allocated |
Splits an URI list conforming to the text/uri-list mime type defined in RFC 2483 into individual URIs, discarding any comments. The URIs are not validated.
Since: 2.6
parse
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> [UriFlags] |
|
-> m Uri |
Parses uriString
according to flags
. If the result is not a
valid [absolute URI][relative-absolute-uris], it will be discarded, and an
error returned.
Since: 2.66
parseParams
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> Int64 |
|
-> Text |
|
-> [UriParamsFlags] |
|
-> m (Map Text Text) | Returns: A hash table of
attribute/value pairs, with both names and values fully-decoded; or |
Many URI schemes include one or more attribute/value pairs as part of the URI
value. This method can be used to parse them into a hash table. When an
attribute has multiple occurrences, the last value is the final returned
value. If you need to handle repeated attributes differently, use
UriParamsIter
.
The params
string is assumed to still be %
-encoded, but the returned
values will be fully decoded. (Thus it is possible that the returned values
may contain =
or separators
, if the value was encoded in the input.)
Invalid %
-encoding is treated as with the UriFlagsParseRelaxed
rules for uriParse
. (However, if params
is the path or query string
from a Uri
that was parsed without UriFlagsParseRelaxed
and
UriFlagsEncoded
, then you already know that it does not contain any
invalid encoding.)
UriParamsFlagsWwwForm
is handled as documented for uriParamsIterInit
.
If UriParamsFlagsCaseInsensitive
is passed to flags
, attributes will be
compared case-insensitively, so a params string attr=123&Attr=456
will only
return a single attribute–value pair, Attr=456
. Case will be preserved in
the returned attributes.
If params
cannot be parsed (for example, it contains two separators
characters in a row), then error
is set and Nothing
is returned.
Since: 2.66
parseRelative
:: (HasCallStack, MonadIO m) | |
=> Uri |
|
-> Text |
|
-> [UriFlags] |
|
-> m Uri |
Parses uriRef
according to flags
and, if it is a
[relative URI][relative-absolute-uris], resolves it relative to baseUri
.
If the result is not a valid absolute URI, it will be discarded, and an error
returned.
Since: 2.66
parseScheme
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m (Maybe Text) | Returns: The ‘scheme’ component of the URI, or
|
Gets the scheme portion of a URI string. RFC 3986 decodes the scheme as: > >URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
Common schemes include file
, https
, svn+ssh
, etc.
Since: 2.16
peekScheme
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m (Maybe Text) | Returns: The ‘scheme’ component of the URI, or
|
Gets the scheme portion of a URI string. RFC 3986 decodes the scheme as: > >URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
Common schemes include file
, https
, svn+ssh
, etc.
Unlike uriParseScheme
, the returned scheme is normalized to
all-lowercase and does not need to be freed.
Since: 2.66
resolveRelative
:: (HasCallStack, MonadIO m) | |
=> Maybe Text |
|
-> Text |
|
-> [UriFlags] |
|
-> m Text | Returns: the resolved URI string. (Can throw |
Parses uriRef
according to flags
and, if it is a
[relative URI][relative-absolute-uris], resolves it relative to
baseUriString
. If the result is not a valid absolute URI, it will be
discarded, and an error returned.
(If baseUriString
is Nothing
, this just returns uriRef
, or
Nothing
if uriRef
is invalid or not absolute.)
Since: 2.66
split
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> [UriFlags] |
|
-> m (Maybe Text, Maybe Text, Maybe Text, Int32, Text, Maybe Text, Maybe Text) | (Can throw |
Parses uriRef
(which can be an
[absolute or relative URI][relative-absolute-uris]) according to flags
, and
returns the pieces. Any component that doesn't appear in uriRef
will be
returned as Nothing
(but note that all URIs always have a path component,
though it may be the empty string).
If flags
contains UriFlagsEncoded
, then %
-encoded characters in
uriRef
will remain encoded in the output strings. (If not,
then all such characters will be decoded.) Note that decoding will
only work if the URI components are ASCII or UTF-8, so you will
need to use UriFlagsEncoded
if they are not.
Note that the UriFlagsHasPassword
and
UriFlagsHasAuthParams
flags
are ignored by uriSplit
,
since it always returns only the full userinfo; use
uriSplitWithUser
if you want it split up.
Since: 2.66
splitNetwork
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> [UriFlags] |
|
-> m (Maybe Text, Maybe Text, Int32) | (Can throw |
Parses uriString
(which must be an [absolute URI][relative-absolute-uris])
according to flags
, and returns the pieces relevant to connecting to a host.
See the documentation for uriSplit
for more details; this is
mostly a wrapper around that function with simpler arguments.
However, it will return an error if uriString
is a relative URI,
or does not contain a hostname component.
Since: 2.66
splitWithUser
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> [UriFlags] |
|
-> m (Maybe Text, Maybe Text, Maybe Text, Maybe Text, Maybe Text, Int32, Text, Maybe Text, Maybe Text) | (Can throw |
Parses uriRef
(which can be an
[absolute or relative URI][relative-absolute-uris]) according to flags
, and
returns the pieces. Any component that doesn't appear in uriRef
will be
returned as Nothing
(but note that all URIs always have a path component,
though it may be the empty string).
See uriSplit
, and the definition of UriFlags
, for more
information on the effect of flags
. Note that password
will only
be parsed out if flags
contains UriFlagsHasPassword
, and
authParams
will only be parsed out if flags
contains
UriFlagsHasAuthParams
.
Since: 2.66
toString
:: (HasCallStack, MonadIO m) | |
=> Uri |
|
-> m Text | Returns: a string representing |
Returns a string representing uri
.
This is not guaranteed to return a string which is identical to the
string that uri
was parsed from. However, if the source URI was
syntactically correct (according to RFC 3986), and it was parsed
with UriFlagsEncoded
, then uriToString
is guaranteed to return
a string which is at least semantically equivalent to the source
URI (according to RFC 3986).
If uri
might contain sensitive details, such as authentication parameters,
or private data in its query string, and the returned string is going to be
logged, then consider using uriToStringPartial
to redact parts.
Since: 2.66
toStringPartial
:: (HasCallStack, MonadIO m) | |
=> Uri |
|
-> [UriHideFlags] |
|
-> m Text | Returns: a string representing |
Returns a string representing uri
, subject to the options in
flags
. See uriToString
and UriHideFlags
for more details.
Since: 2.66
unescapeBytes
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> Int64 |
|
-> Maybe Text |
|
-> m Bytes | Returns: an unescaped version of |
Unescapes a segment of an escaped string as binary data.
Note that in contrast to uriUnescapeString
, this does allow
nul bytes to appear in the output.
If any of the characters in illegalCharacters
appears as an escaped
character in escapedString
, then that is an error and Nothing
will be
returned. This is useful if you want to avoid for instance having a slash
being expanded in an escaped path element, which might confuse pathname
handling.
Since: 2.66
unescapeSegment
:: (HasCallStack, MonadIO m) | |
=> Maybe Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> m Text | Returns: an unescaped version of |
Unescapes a segment of an escaped string.
If any of the characters in illegalCharacters
or the NUL
character appears as an escaped character in escapedString
, then
that is an error and Nothing
will be returned. This is useful if you
want to avoid for instance having a slash being expanded in an
escaped path element, which might confuse pathname handling.
Note: NUL
byte is not accepted in the output, in contrast to
uriUnescapeBytes
.
Since: 2.16
unescapeString
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> Maybe Text |
|
-> m Text | Returns: an unescaped version of |
Unescapes a whole escaped string.
If any of the characters in illegalCharacters
or the NUL
character appears as an escaped character in escapedString
, then
that is an error and Nothing
will be returned. This is useful if you
want to avoid for instance having a slash being expanded in an
escaped path element, which might confuse pathname handling.
Since: 2.16