API reference
Preparing search index…

Native Rml::URL resource parser, independent of runtime initialisation.

Uses RmlUi resource URL rules. Parameter order is native unordered-map order. The native owner is released when the wrapper is collected.

Source & inheritance
Member directory29

Constructors

Methods

Constructors

  • Construct Rml::URL from UTF-8 text.

    Parameters

    value
    string = ''

    Resource URL; empty by default.

    Returns

    Source & inheritance

Methods

  • Clear Rml::URL::ClearParameters and invalidate its query cache.

    Returns

    void
    Source & inheritance
  • Get the file extension without the leading dot.

    Returns

    string

    Extension without dot.

    Source & inheritance
  • Get the file name without its extension.

    Returns

    string

    File name without extension.

    Source & inheritance
  • Get the host component of the URL.

    Returns

    string

    Host text.

    Source & inheritance
  • Get the login name in the URL authority.

    Returns

    string

    Login text.

    Source & inheritance
  • Copy Rml::URL::GetParameters into an independent object.

    Returns

    Record<string, string>

    Parameter snapshot, including keys such as "proto".

    Source & inheritance
  • Get the password in the URL authority.

    Returns

    string

    Password text.

    Source & inheritance
  • Get the directory path before the file name.

    Returns

    string

    Path before file name.

    Source & inheritance
  • Get the combined path, file name and extension.

    Returns

    string

    Path, file name and extension.

    Source & inheritance
  • Get the numeric port of the URL.

    Returns

    number

    Native port.

    Source & inheritance
  • Get the URL protocol.

    Returns

    string

    Protocol.

    Source & inheritance
  • Read Rml::URL::GetQueryString with native percent encoding.

    Returns

    string

    Query without the leading question mark.

    Source & inheritance
  • Read the reconstructed Rml::URL::GetURL string.

    Returns

    string

    Complete resource URL.

    Source & inheritance
  • Compare native reconstructed bytes with Rml::URL::operator<.

    Parameters

    other

    Other native URL.

    Returns

    boolean

    Whether this URL sorts before the other.

    Source & inheritance
  • Prefix Rml::URL::PrefixPath, adding a separator when needed.

    Parameters

    value
    string

    Prefix path.

    Returns

    boolean

    Native setter result.

    Source & inheritance
  • Set the file extension without the leading dot.

    Parameters

    value
    string

    Extension without dot.

    Returns

    boolean

    Native setter result.

    Source & inheritance
  • Set the file name without its extension.

    Parameters

    value
    string

    File name without extension.

    Returns

    boolean

    Native setter result.

    Source & inheritance
  • Set the host component of the URL.

    Parameters

    value
    string

    Host text.

    Returns

    boolean

    Native setter result.

    Source & inheritance
  • Set the login name in the URL authority.

    Parameters

    value
    string

    Login text.

    Returns

    boolean

    Native setter result.

    Source & inheritance
  • Set one Rml::URL::SetParameter entry.

    Parameters

    name
    string

    Parameter name.

    value
    string

    Parameter value.

    Returns

    void
    Source & inheritance
  • Replace Rml::URL::SetParameters after validating every entry.

    Parameters

    values
    Readonly<Record<string, string>>

    Own string properties of the parameter object.

    Returns

    void
    Source & inheritance
  • Set the password in the URL authority.

    Parameters

    value
    string

    Password text.

    Returns

    boolean

    Native setter result.

    Source & inheritance
  • Set Rml::URL::SetPath without implicit trailing slash insertion.

    Parameters

    value
    string

    Path prefix before file name.

    Returns

    boolean

    Native setter result.

    Source & inheritance
  • Set Rml::URL::SetPort using a checked signed 32-bit integer.

    Parameters

    value
    number

    Native port value.

    Returns

    boolean

    Native setter result.

    Source & inheritance
  • Set the URL protocol without the separator.

    Parameters

    value
    string

    Protocol without separator.

    Returns

    boolean

    Native setter result.

    Source & inheritance
  • Replace all components through Rml::URL::SetURL.

    Parameters

    value
    string

    Replacement resource URL.

    Returns

    boolean

    Native parsing success; malformed input can leave partial state.

    Source & inheritance
  • Decode Rml::URL::UrlDecode, including its permissive escape handling.

    Parameters

    value
    string

    Encoded text; "+" becomes a space.

    Returns

    string

    Decoded UTF-8 text; invalid UTF-8 becomes replacement characters.

    Source & inheritance
  • Encode all UTF-8 bytes with Rml::URL::UrlEncode, including embedded NUL.

    Parameters

    value
    string

    Text to encode.

    Returns

    string

    Native percent-encoded text.

    Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0