<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>RAUL: Raul::URI Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"> <ul> <li><b>Raul</b> </li> <li><a class="el" href="classRaul_1_1URI.html">Raul::URI</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> </div> <div class="headertitle"> <h1>Raul::URI Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="Raul::URI" --> <p>Simple wrapper around standard string with useful URI-specific methods. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="URI_8hpp_source.html">URI.hpp</a>></code></p> <p>Inherited by <a class="el" href="classRaul_1_1Path.html">Raul::Path</a>.</p> <p><a href="classRaul_1_1URI-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1URI.html#a2404de28464decda67b52cfa899a6695">URI</a> (const std::basic_string< char > &uri="nil:0")</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a> from an std::string. <a href="#a2404de28464decda67b52cfa899a6695"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1URI.html#a0c3dd58104fab5b5bd1afc606ad72a64">URI</a> (const char *uri)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a> from a C string. <a href="#a0c3dd58104fab5b5bd1afc606ad72a64"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28723bac7dcdd82cf17cf1b23d6f391b"></a><!-- doxytag: member="Raul::URI::chop_start" ref="a28723bac7dcdd82cf17cf1b23d6f391b" args="(const std::string &str) const " --> const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1URI.html#a28723bac7dcdd82cf17cf1b23d6f391b">chop_start</a> (const std::string &str) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return path with everything up to and including the first occurence of str chopped. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51a913a3c2cf8733aa9afbd2ae1413a0"></a><!-- doxytag: member="Raul::URI::chop_scheme" ref="a51a913a3c2cf8733aa9afbd2ae1413a0" args="() const " --> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1URI.html#a51a913a3c2cf8733aa9afbd2ae1413a0">chop_scheme</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the <a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a> with the scheme removed (as a string). <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae771b35853016556a97ce5cc47631d9f"></a><!-- doxytag: member="Raul::URI::scheme" ref="ae771b35853016556a97ce5cc47631d9f" args="() const " --> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1URI.html#ae771b35853016556a97ce5cc47631d9f">scheme</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the <a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a> scheme (everything before the first ':'). <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a288fc43664f0f5ecfe5710a4c453c4df"></a><!-- doxytag: member="Raul::URI::str" ref="a288fc43664f0f5ecfe5710a4c453c4df" args="() const " --> const std::string </td><td class="memItemRight" valign="bottom"><b>str</b> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1a9e8bcbbb2f944a0b24119fb827dc3"></a><!-- doxytag: member="Raul::URI::c_str" ref="ad1a9e8bcbbb2f944a0b24119fb827dc3" args="() const " --> const char * </td><td class="memItemRight" valign="bottom"><b>c_str</b> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf327799860e5289ae3f42f0900a9d2e"></a><!-- doxytag: member="Raul::URI::substr" ref="abf327799860e5289ae3f42f0900a9d2e" args="(size_t start, size_t end=std::string::npos) const " --> std::string </td><td class="memItemRight" valign="bottom"><b>substr</b> (size_t start, size_t end=std::string::npos) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3392850fbade664dc11ba44ccf13d9a3"></a><!-- doxytag: member="Raul::URI::operator<" ref="a3392850fbade664dc11ba44ccf13d9a3" args="(const URI &uri) const " --> bool </td><td class="memItemRight" valign="bottom"><b>operator<</b> (const <a class="el" href="classRaul_1_1URI.html">URI</a> &uri) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22b19fc7d04e3177c7bcd927334dd8ad"></a><!-- doxytag: member="Raul::URI::operator<=" ref="a22b19fc7d04e3177c7bcd927334dd8ad" args="(const URI &uri) const " --> bool </td><td class="memItemRight" valign="bottom"><b>operator<=</b> (const <a class="el" href="classRaul_1_1URI.html">URI</a> &uri) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4aa3f85e89ebe6b539ae2e12b385a6f7"></a><!-- doxytag: member="Raul::URI::operator==" ref="a4aa3f85e89ebe6b539ae2e12b385a6f7" args="(const URI &uri) const " --> bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classRaul_1_1URI.html">URI</a> &uri) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa257f9c1f66196164f028c46c1bdc0e"></a><!-- doxytag: member="Raul::URI::operator!=" ref="afa257f9c1f66196164f028c46c1bdc0e" args="(const URI &uri) const " --> bool </td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="classRaul_1_1URI.html">URI</a> &uri) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2160bd643ff5171cef6a0e7a0b887ffa"></a><!-- doxytag: member="Raul::URI::length" ref="a2160bd643ff5171cef6a0e7a0b887ffa" args="() const " --> size_t </td><td class="memItemRight" valign="bottom"><b>length</b> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ff451fc1c027e642115e3fbb1fa7f6d"></a><!-- doxytag: member="Raul::URI::find" ref="a8ff451fc1c027e642115e3fbb1fa7f6d" args="(const std::string &s) const " --> size_t </td><td class="memItemRight" valign="bottom"><b>find</b> (const std::string &s) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a953dd3dc2e2e433879d34a4a6c734a32"></a><!-- doxytag: member="Raul::URI::find_last_of" ref="a953dd3dc2e2e433879d34a4a6c734a32" args="(char c) const " --> size_t </td><td class="memItemRight" valign="bottom"><b>find_last_of</b> (char c) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af883f386a98c34dbb0fb5d131d937849"></a><!-- doxytag: member="Raul::URI::operator Raul::Atom" ref="af883f386a98c34dbb0fb5d131d937849" args="() const " --> </td><td class="memItemRight" valign="bottom"><b>operator Raul::Atom</b> () const </td></tr> <tr><td colspan="2"><h2><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc3a1a8013e04710c8110a54f782db46"></a><!-- doxytag: member="Raul::URI::is_valid" ref="afc3a1a8013e04710c8110a54f782db46" args="(const std::basic_string< char > &uri)" --> static bool </td><td class="memItemRight" valign="bottom"><b>is_valid</b> (const std::basic_string< char > &uri)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Simple wrapper around standard string with useful URI-specific methods. </p> <p>This "should" be used for proper URIs (RFC3986), but not much support or validation is built-in yet. The <a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a> string MUST have a scheme though. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a2404de28464decda67b52cfa899a6695"></a><!-- doxytag: member="Raul::URI::URI" ref="a2404de28464decda67b52cfa899a6695" args="(const std::basic_string< char > &uri="nil:0")" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Raul::URI::URI </td> <td>(</td> <td class="paramtype">const std::basic_string< char > & </td> <td class="paramname"> <em>uri</em> = <code>"nil:0"</code></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a <a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a> from an std::string. </p> <p>It is a fatal error to construct a <a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a> from an invalid string, use is_valid first to check. </p> </div> </div> <a class="anchor" id="a0c3dd58104fab5b5bd1afc606ad72a64"></a><!-- doxytag: member="Raul::URI::URI" ref="a0c3dd58104fab5b5bd1afc606ad72a64" args="(const char *uri)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Raul::URI::URI </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>uri</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a <a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a> from a C string. </p> <p>It is a fatal error to construct a <a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a> from an invalid string, use is_valid first to check. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="URI_8hpp_source.html">URI.hpp</a></li> </ul> </div> <hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> </body> </html>