Struct URISchemeRequest 

pub struct URISchemeRequest { /* private fields */ }

Represents a URI scheme request.

If you register a particular URI scheme in a WebContext, using WebContext::register_uri_scheme(), you have to provide a WebKitURISchemeRequestCallback. After that, when a URI request is made with that particular scheme, your callback will be called. There you will be able to access properties such as the scheme, the URI and path, and the WebView that initiated the request, and also finish the request with finish().

GLib type: GObject with reference counted clone semantics.

Implementations

impl URISchemeRequest

pub fn finish( &self, stream: &impl IsA<InputStream>, stream_length: i64, content_type: Option<&str>, )

Finish a URISchemeRequest by setting the contents of the request and its mime type.

stream

a gio::InputStream to read the contents of the request

stream_length

the length of the stream or -1 if not known

content_type

the content type of the stream or None if not known

pub fn finish_error(&self, error: &mut Error)

Finish a URISchemeRequest with a glib::Error.

error

a glib::Error that will be passed to the WebView

pub fn finish_with_response(&self, response: &URISchemeResponse)

Finish a URISchemeRequest by returning a URISchemeResponse

response

a URISchemeResponse

pub fn http_body(&self) -> Option<InputStream>

Get the request body.

Returns

(nullable): the body of the self.

pub fn http_headers(&self) -> Option<MessageHeaders>

Get the [soup::MessageHeaders][crate::soup::MessageHeaders] of the request.

Returns

the [soup::MessageHeaders][crate::soup::MessageHeaders] of the self.

pub fn http_method(&self) -> Option<GString>

Get the HTTP method of the self.

Returns

the HTTP method of the self

pub fn path(&self) -> Option<GString>

Get the URI path of self.

Returns

the URI path of self

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

Get the URI scheme of self.

Returns

the URI scheme of self

pub fn uri(&self) -> Option<GString>

Get the URI of self.

Returns

the full URI of self

pub fn web_view(&self) -> Option<WebView>

Get the WebView that initiated the request.

Returns

the WebView that initiated self.

Trait Implementations

impl Clone for URISchemeRequest

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for URISchemeRequest

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

Formats the value using the given formatter.

impl HasParamSpec for URISchemeRequest

type ParamSpec = ParamSpecObject

type SetValue = URISchemeRequest

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, URISchemeRequest>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for URISchemeRequest

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for URISchemeRequest

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for URISchemeRequest

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for URISchemeRequest

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

impl<OT: ObjectType> PartialOrd<OT> for URISchemeRequest

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for URISchemeRequest

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for URISchemeRequest