Struct cxx_qt_lib::QUrl

#[repr(C)]
pub struct QUrl { /* private fields */ }

The QUrl class provides a convenient interface for working with URLs.

Implementations

impl QUrl

pub fn clear(&mut self)

Resets the content of the QUrl. After calling this function, the QUrl is equal to one that has been constructed with the default empty constructor.

impl QUrl

pub fn error_string(&self) -> QString

Returns an error message if the last operation that modified this QUrl object ran into a parsing error. If no error was detected, this function returns an empty string and isValid() returns true.

impl QUrl

pub fn has_fragment(&self) -> bool

Returns true if this URL contains a fragment (i.e., if # was seen on it).

impl QUrl

pub fn has_query(&self) -> bool

Returns true if this URL contains a Query (i.e., if ? was seen on it).

impl QUrl

pub fn is_empty(&self) -> bool

Returns true if the URL has no data; otherwise returns false.

impl QUrl

pub fn is_local_file(&self) -> bool

Returns true if this URL is pointing to a local file path. A URL is a local file path if the scheme is “file”.

impl QUrl

pub fn is_parent_of(&self, child_url: &QUrl) -> bool

Returns true if this URL is a parent of child_url. childUrl is a child of this URL if the two URLs share the same scheme and authority, and this URL’s path is a parent of the path of child_url.

impl QUrl

pub fn is_relative(&self) -> bool

Returns true if the URL is relative; otherwise returns false. A URL is relative reference if its scheme is undefined; this function is therefore equivalent to calling scheme().is_empty().

impl QUrl

pub fn is_valid(&self) -> bool

Returns true if the URL is non-empty and valid; otherwise returns false.

impl QUrl

pub fn port_or(&self, port: i32) -> i32

Returns the port of the URL, or defaultPort if the port is unspecified.

impl QUrl

pub fn resolved(&self, relative: &QUrl) -> QUrl

Returns the result of the merge of this URL with relative. This URL is used as a base to convert relative to an absolute URL.

impl QUrl

pub fn scheme_or_default(&self) -> QString

Returns the scheme of the URL. If an empty string is returned, this means the scheme is undefined and the URL is then relative.

The scheme can only contain US-ASCII letters or digits, which means it cannot contain any character that would otherwise require encoding Additionally, schemes are always returned in lowercase form.

impl QUrl

pub fn set_port(&mut self, port: i32)

Sets the port of the URL to port.

port must be between 0 and 65535 inclusive. Setting the port to -1 indicates that the port is unspecified.

impl QUrl

pub fn to_local_file_or_default(&self) -> QString

Returns the path of this URL formatted as a local file path. The path returned will use forward slashes, even if it was originally created from one with backslashes.

impl QUrl

pub fn authority_or_default(&self) -> QString

Returns the authority of the URL if it is defined; otherwise an empty string is returned.

pub fn file_name(&self) -> QString

Returns the name of the file, excluding the directory path.

Note that, if this QUrl object is given a path ending in a slash, the name of the file is considered empty.

If the path doesn’t contain any slash, it is fully returned as the fileName.

pub fn fragment(&self) -> Option<QString>

Returns the fragment of the URL.

pub fn fragment_or_default(&self) -> QString

Returns the fragment of the URL if it is defined; otherwise an empty string is returned.

pub fn from_encoded(input: &QByteArray) -> Self

Parses input and returns the corresponding QUrl. input is assumed to be in encoded form, containing only ASCII characters.

pub fn from_local_file(local_file: &QString) -> Self

Returns a QUrl representation of localFile, interpreted as a local file. This function accepts paths separated by slashes as well as the native separator for this platform.

pub fn from_percent_encoding(input: &QByteArray) -> QString

Returns a decoded copy of input. input is first decoded from percent encoding, then converted from UTF-8 to unicode.

pub fn from_user_input( user_input: &QString, working_directory: &QString ) -> Self

Returns a valid URL from a user supplied userInput string if one can be deduced. In the case that is not possible, an invalid QUrl() is returned.

pub fn host_or_default(&self) -> QString

Returns the host of the URL if it is defined; otherwise an empty string is returned.

pub fn idn_whitelist() -> QStringList

Returns the current whitelist of top-level domains that are allowed to have non-ASCII characters in their compositions.

pub fn password_or_default(&self) -> QString

Returns the password of the URL if it is defined; otherwise an empty string is returned.

pub fn path(&self) -> QString

Returns the path of the URL.

pub fn query(&self) -> Option<QString>

Returns the query string of the URL if there’s a query string

pub fn query_or_default(&self) -> QString

Returns the query string of the URL if it is defined; otherwise an empty string is returned.

pub fn scheme(&self) -> Option<QString>

Returns the scheme of the URL. If the Option is None, this means the scheme is undefined and the URL is then relative.

The scheme can only contain US-ASCII letters or digits, which means it cannot contain any character that would otherwise require encoding Additionally, schemes are always returned in lowercase form.

pub fn set_authority(&mut self, authority: &QString)

Sets the authority of the URL to authority.

pub fn set_fragment(&mut self, fragment: &QString)

Sets the fragment of the URL to fragment. The fragment is the last part of the URL, represented by a ‘#’ followed by a string of characters.

pub fn set_host(&mut self, host: &QString)

Sets the host of the URL to host. The host is part of the authority.

pub fn set_idn_whitelist(list: &QStringList)

Sets the whitelist of Top-Level Domains (TLDs) that are allowed to have non-ASCII characters in domains to the value of list.

pub fn set_password(&mut self, password: &QString)

Sets the URL’s password to password.

pub fn set_path(&mut self, path: &QString)

Sets the path of the URL to path. The path is the part of the URL that comes after the authority but before the query string.

pub fn set_query(&mut self, query: &QString)

Sets the query string of the URL to query.

pub fn set_scheme(&mut self, scheme: &QString)

Sets the scheme of the URL to scheme. As a scheme can only contain ASCII characters, no conversion or decoding is done on the input. It must also start with an ASCII letter.

pub fn set_url(&mut self, url: &QString)

Parses url and sets this object to that value. QUrl will automatically percent encode all characters that are not allowed in a URL and decode the percent-encoded sequences that represent an unreserved character (letters, digits, hyphens, underscores, dots and tildes). All other characters are left in their original forms.

pub fn set_user_info(&mut self, user_info: &QString)

Sets the user info of the URL to userInfo.

pub fn set_user_name(&mut self, user_name: &QString)

Sets the URL’s user name to userName.

pub fn to_display_string(&self) -> QString

Returns a human-displayable string representation of the URL. The option RemovePassword is always enabled, since passwords should never be shown back to users.

pub fn to_encoded(&self) -> QByteArray

Returns the encoded representation of the URL if it’s valid; otherwise an empty QByteArray is returned.

pub fn to_local_file(&self) -> Option<QString>

Returns the path of this URL formatted as a local file path. The path returned will use forward slashes, even if it was originally created from one with backslashes.

pub fn to_percent_encoding( input: &QString, exclude: &QByteArray, include: &QByteArray ) -> QByteArray

Returns an encoded copy of input. input is first converted to UTF-8, and all ASCII-characters that are not in the unreserved group are percent encoded. To prevent characters from being percent encoded pass them to exclude. To force characters to be percent encoded pass them to include.

pub fn to_qstring(&self) -> QString

Returns a QString representation of the URL.

pub fn user_info_or_default(&self) -> QString

Returns the user info of the URL, or an empty string if the user info is undefined.

pub fn user_name_or_default(&self) -> QString

Returns the user name of the URL if it is defined; otherwise an empty string is returned.

Trait Implementations

impl Clone for QUrl

fn clone(&self) -> Self

Constructs a copy of other.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QUrl

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QUrl

fn default() -> Self

Constructs an empty QUrl object.

impl Display for QUrl

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Convert the QUrl to a Rust string

Note that this converts from UTF-16 to UTF-8

impl Drop for QUrl

fn drop(&mut self)

Destructor; called immediately before the object is deleted.

impl ExternType for QUrl

type Id = (Q, U, r, l)

A type-level representation of the type’s C++ namespace and type name.

type Kind = Trivial

Either cxx::kind::Opaque or cxx::kind::Trivial.

impl From<&QString> for QUrl

fn from(str: &QString) -> Self

Constructs a QUrl from a QString

impl From<&String> for QUrl

fn from(str: &String) -> Self

Constructs a QUrl from a Rust string

Note that this converts from UTF-8 to UTF-16

impl From<&str> for QUrl

fn from(str: &str) -> Self

Constructs a QUrl from a Rust string

Note that this converts from UTF-8 to UTF-16

impl PartialEq for QUrl

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl QListElement for QUrl

type TypeId = (Q, L, i, s, t, __, Q, U, r, l)

fn append(list: &mut QList<Self>, value: Self)

fn append_clone(list: &mut QList<Self>, value: &Self)

fn clear(list: &mut QList<Self>)

fn clone(list: &QList<Self>) -> QList<Self>

fn contains(list: &QList<Self>, value: &Self) -> bool

fn default() -> QList<Self>

fn drop(list: &mut QList<Self>)

unsafe fn get_unchecked(list: &QList<Self>, pos: isize) -> &Self

Safety

fn index_of(list: &QList<Self>, value: &Self) -> isize

fn insert(list: &mut QList<Self>, pos: isize, value: Self)

fn insert_clone(list: &mut QList<Self>, pos: isize, value: &Self)

fn len(list: &QList<Self>) -> isize

fn remove(list: &mut QList<Self>, pos: isize)

fn reserve(list: &mut QList<Self>, size: isize)

impl QSetElement for QUrl

type TypeId = (Q, S, e, t, __, Q, U, r, l)

fn clear(set: &mut QSet<Self>)

fn clone(set: &QSet<Self>) -> QSet<Self>

fn contains(set: &QSet<Self>, value: &Self) -> bool

fn default() -> QSet<Self>

fn drop(set: &mut QSet<Self>)

unsafe fn get_unchecked(set: &QSet<Self>, pos: isize) -> &Self

Safety

fn insert(set: &mut QSet<Self>, value: Self)

fn insert_clone(set: &mut QSet<Self>, value: &Self)

fn len(set: &QSet<Self>) -> isize

fn remove(set: &mut QSet<Self>, value: &Self) -> bool

impl QVariantValue for QUrl

fn can_convert(variant: &QVariant) -> bool

fn construct(value: &Self) -> QVariant

fn value_or_default(variant: &QVariant) -> Self

impl QVectorElement for QUrl

type TypeId = (Q, V, e, c, t, o, r, __, Q, U, r, l)

fn append(vector: &mut QVector<Self>, value: Self)

fn append_clone(vector: &mut QVector<Self>, value: &Self)

fn clear(vector: &mut QVector<Self>)

fn clone(vector: &QVector<Self>) -> QVector<Self>

fn contains(vector: &QVector<Self>, value: &Self) -> bool

fn default() -> QVector<Self>

fn drop(vector: &mut QVector<Self>)

unsafe fn get_unchecked(vector: &QVector<Self>, pos: isize) -> &Self

Safety

fn index_of(vector: &QVector<Self>, value: &Self) -> isize

fn insert(vector: &mut QVector<Self>, pos: isize, value: Self)

fn insert_clone(vector: &mut QVector<Self>, pos: isize, value: &Self)

fn len(vector: &QVector<Self>) -> isize

fn remove(vector: &mut QVector<Self>, pos: isize)

fn reserve(vector: &mut QVector<Self>, size: isize)

impl Eq for QUrl