Struct xpcom::interfaces::nsIFileURL
[−]
[src]
#[repr(C)]pub struct nsIFileURL { /* fields omitted */ }
interface nsIFileURL : nsIURL
/**
* nsIFileURL provides access to the underlying nsIFile object corresponding to
* an URL. The URL scheme need not be file:, since other local protocols may
* map URLs to files (e.g., resource:).
*/
Methods
impl nsIFileURL
[src]
pub fn coerce<T: nsIFileURLCoerce>(&self) -> &T
[src]
Cast this nsIFileURL
to one of its base interfaces.
impl nsIFileURL
[src]
pub unsafe fn GetFile(&self, aFile: *mut *const nsIFile) -> nsresult
[src]
/**
* Get/Set nsIFile corresponding to this URL.
*
* - Getter returns a reference to an immutable object. Callers must clone
* before attempting to modify the returned nsIFile object. NOTE: this
* constraint might not be enforced at runtime, so beware!!
*
* - Setter clones the nsIFile object (allowing the caller to safely modify
* the nsIFile object after setting it on this interface).
*/
attribute nsIFile file;
pub unsafe fn SetFile(&self, aFile: *const nsIFile) -> nsresult
[src]
/**
* Get/Set nsIFile corresponding to this URL.
*
* - Getter returns a reference to an immutable object. Callers must clone
* before attempting to modify the returned nsIFile object. NOTE: this
* constraint might not be enforced at runtime, so beware!!
*
* - Setter clones the nsIFile object (allowing the caller to safely modify
* the nsIFile object after setting it on this interface).
*/
attribute nsIFile file;
Methods from Deref<Target = nsIURL>
pub unsafe fn GetDirectory(&self, aDirectory: &mut nsACString) -> nsresult
[src]
/*************************************************************************
* The URL path is broken down into the following principal components:
*
* attribute AUTF8String filePath;
* attribute AUTF8String query;
*
* These are inherited from nsIURI.
*/
/*************************************************************************
* The URL filepath is broken down into the following sub-components:
*/
/**
* Returns the directory portion of a URL. If the URL denotes a path to a
* directory and not a file, e.g. http://host/foo/bar/, then the Directory
* attribute accesses the complete /foo/bar/ portion, and the FileName is
* the empty string. If the trailing slash is omitted, then the Directory
* is /foo/ and the file is bar (i.e. this is a syntactic, not a semantic
* breakdown of the Path). And hence don't rely on this for something to
* be a definitely be a file. But you can get just the leading directory
* portion for sure.
*
* Some characters may be escaped.
*/
attribute AUTF8String directory;
pub unsafe fn SetDirectory(&self, aDirectory: &nsACString) -> nsresult
[src]
/*************************************************************************
* The URL path is broken down into the following principal components:
*
* attribute AUTF8String filePath;
* attribute AUTF8String query;
*
* These are inherited from nsIURI.
*/
/*************************************************************************
* The URL filepath is broken down into the following sub-components:
*/
/**
* Returns the directory portion of a URL. If the URL denotes a path to a
* directory and not a file, e.g. http://host/foo/bar/, then the Directory
* attribute accesses the complete /foo/bar/ portion, and the FileName is
* the empty string. If the trailing slash is omitted, then the Directory
* is /foo/ and the file is bar (i.e. this is a syntactic, not a semantic
* breakdown of the Path). And hence don't rely on this for something to
* be a definitely be a file. But you can get just the leading directory
* portion for sure.
*
* Some characters may be escaped.
*/
attribute AUTF8String directory;
pub unsafe fn GetFileName(&self, aFileName: &mut nsACString) -> nsresult
[src]
/**
* Returns the file name portion of a URL. If the URL denotes a path to a
* directory and not a file, e.g. http://host/foo/bar/, then the Directory
* attribute accesses the complete /foo/bar/ portion, and the FileName is
* the empty string. Note that this is purely based on searching for the
* last trailing slash. And hence don't rely on this to be a definite file.
*
* Some characters may be escaped.
*/
attribute AUTF8String fileName;
pub unsafe fn SetFileName(&self, aFileName: &nsACString) -> nsresult
[src]
/**
* Returns the file name portion of a URL. If the URL denotes a path to a
* directory and not a file, e.g. http://host/foo/bar/, then the Directory
* attribute accesses the complete /foo/bar/ portion, and the FileName is
* the empty string. Note that this is purely based on searching for the
* last trailing slash. And hence don't rely on this to be a definite file.
*
* Some characters may be escaped.
*/
attribute AUTF8String fileName;
pub unsafe fn GetFileBaseName(&self, aFileBaseName: &mut nsACString) -> nsresult
[src]
/*************************************************************************
* The URL filename is broken down even further:
*/
/**
* Returns the file basename portion of a filename in a url.
*
* Some characters may be escaped.
*/
attribute AUTF8String fileBaseName;
pub unsafe fn SetFileBaseName(&self, aFileBaseName: &nsACString) -> nsresult
[src]
/*************************************************************************
* The URL filename is broken down even further:
*/
/**
* Returns the file basename portion of a filename in a url.
*
* Some characters may be escaped.
*/
attribute AUTF8String fileBaseName;
pub unsafe fn GetFileExtension(
&self,
aFileExtension: &mut nsACString
) -> nsresult
[src]
&self,
aFileExtension: &mut nsACString
) -> nsresult
/**
* Returns the file extension portion of a filename in a url. If a file
* extension does not exist, the empty string is returned.
*
* Some characters may be escaped.
*/
attribute AUTF8String fileExtension;
pub unsafe fn SetFileExtension(&self, aFileExtension: &nsACString) -> nsresult
[src]
/**
* Returns the file extension portion of a filename in a url. If a file
* extension does not exist, the empty string is returned.
*
* Some characters may be escaped.
*/
attribute AUTF8String fileExtension;
pub unsafe fn GetCommonBaseSpec(
&self,
aURIToCompare: *const nsIURI,
_retval: &mut nsACString
) -> nsresult
[src]
&self,
aURIToCompare: *const nsIURI,
_retval: &mut nsACString
) -> nsresult
/**
* This method takes a uri and compares the two. The common uri portion
* is returned as a string. The minimum common uri portion is the
* protocol, and any of these if present: login, password, host and port
* If no commonality is found, "" is returned. If they are identical, the
* whole path with file/ref/etc. is returned. For file uris, it is
* expected that the common spec would be at least "file:///" since '/' is
* a shared common root.
*
* Examples:
* this.spec aURIToCompare.spec result
* 1) http://mozilla.org/ http://www.mozilla.org/ ""
* 2) http://foo.com/bar/ ftp://foo.com/bar/ ""
* 3) http://foo.com:8080/ http://foo.com/bar/ ""
* 4) ftp://user@foo.com/ ftp://user:pw@foo.com/ ""
* 5) ftp://foo.com/bar/ ftp://foo.com/bar ftp://foo.com/
* 6) ftp://foo.com/bar/ ftp://foo.com/bar/b.html ftp://foo.com/bar/
* 7) http://foo.com/a.htm#i http://foo.com/b.htm http://foo.com/
* 8) ftp://foo.com/c.htm#i ftp://foo.com/c.htm ftp://foo.com/c.htm
* 9) file:///a/b/c.html file:///d/e/c.html file:///
*/
AUTF8String getCommonBaseSpec (in nsIURI aURIToCompare);
pub unsafe fn GetRelativeSpec(
&self,
aURIToCompare: *const nsIURI,
_retval: &mut nsACString
) -> nsresult
[src]
&self,
aURIToCompare: *const nsIURI,
_retval: &mut nsACString
) -> nsresult
/**
* This method tries to create a string which specifies the location of the
* argument relative to |this|. If the argument and |this| are equal, the
* method returns "". If any of the URIs' scheme, host, userpass, or port
* don't match, the method returns the full spec of the argument.
*
* Examples:
* this.spec aURIToCompare.spec result
* 1) http://mozilla.org/ http://www.mozilla.org/ http://www.mozilla.org/
* 2) http://mozilla.org/ http://www.mozilla.org http://www.mozilla.org/
* 3) http://foo.com/bar/ http://foo.com:80/bar/ ""
* 4) http://foo.com/ http://foo.com/a.htm#b a.html#b
* 5) http://foo.com/a/b/ http://foo.com/c ../../c
*/
AUTF8String getRelativeSpec (in nsIURI aURIToCompare);
Trait Implementations
impl XpCom for nsIFileURL
[src]
const IID: nsIID
IID: nsIID = nsID(3910846856, 10178, 17547, [177, 161, 56, 34, 225, 239, 25, 135])
fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>
[src]
Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more
impl RefCounted for nsIFileURL
[src]
unsafe fn addref(&self)
[src]
Increment the reference count.
unsafe fn release(&self)
[src]
Decrement the reference count, potentially freeing backing memory.