text
stringlengths 2
1.05M
|
|---|
<html xmlns:th="http://www.thymeleaf.org">
<body>
<h1>Entradas de blog escritas</h1>
<p th:each="entrada : ${entradasBlog}">
<span th:text="'Nombre ' + ${entrada.nombre}" /> <br />
<span th:text="'Título ' + ${entrada.titulo} " /> <br />
<span th:text="'Mensaje ' + ${entrada.mensaje} " /> <br />
</p>
<a href="/">Volver</a>
<h1>Comentarios escritos</h1>
<p th:each="comment : ${comentarios}">
<span th:text="'Nombre ' + ${comment.nombre} " /> <br />
<span th:text="'Título ' + ${comment.titulo} " /> <br />
<span th:text="'Mensaje ' + ${comment.mensaje} " /> <br />
</p>
<a href="/">Volver</a>
</body>
</html> |
<!DOCTYPE html>
<html>
<head>
<script src="validPositions.js"></script>
<script>
function performTest()
{
showValidPositions();
}
</script>
</head>
<body>
<p> <b> <i> <u> one </u> </i> </b> </p>
</body>
</html>
|
<!DOCTYPE html>
<html lang="en">
<head>
<title>three.ts webgl - nearest neighbour</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
<style>
html, body {
width: 100%;
height: 100%;
}
body {
background-color: #ffffff;
margin: 0;
overflow: hidden;
font-family: arial;
}
#info {
text-align: center;
padding: 5px;
position: absolute;
width: 100%;
color: white;
}
</style>
</head>
<body>
<div id="info"><a href="https://github.com/semleti/three.ts" target="_blank" rel="noopener">three.ts</a> webgl - typed arrays - nearest neighbour for 500,000 sprites</div>
<script src="../build/three.js"></script>
<script src="js/TypedArrayUtils.js"></script>
<script src="js/controls/FirstPersonControls.js"></script>
<script type="x-shader/x-vertex" id="vertexshader">
//uniform float zoom;
attribute float alpha;
varying float vAlpha;
void main() {
vAlpha = 1.0 - alpha;
vec4 mvPosition = modelViewMatrix * vec4( position, 1.0 );
gl_PointSize = 4.0 * ( 300.0 / -mvPosition.z );
gl_Position = projectionMatrix * mvPosition;
}
</script>
<script type="x-shader/x-fragment" id="fragmentshader">
uniform sampler2D tex1;
varying float vAlpha;
void main() {
gl_FragColor = texture2D( tex1, gl_PointCoord );
gl_FragColor.r = ( 1.0 - gl_FragColor.r ) * vAlpha + gl_FragColor.r;
}
</script>
<script>
var camera, scene, renderer;
var controls;
var amountOfParticles = 500000, maxDistance = Math.pow( 120, 2 );
var positions, alphas, particles, _particleGeom;
var clock = new THREE.Clock();
var blocker = document.getElementById( 'blocker' );
var instructions = document.getElementById( 'instructions' );
function init() {
camera = new THREE.PerspectiveCamera( 75, window.innerWidth / window.innerHeight, 1, 1000000 );
scene = new THREE.Scene();
controls = new THREE.FirstPersonControls( camera );
controls.movementSpeed = 100;
controls.lookSpeed = 0.1;
// add a skybox background
var cubeTextureLoader = new THREE.CubeTextureLoader();
cubeTextureLoader.setPath( 'textures/cube/skybox/' );
var cubeTexture = cubeTextureLoader.load( [
'px.jpg', 'nx.jpg',
'py.jpg', 'ny.jpg',
'pz.jpg', 'nz.jpg',
] );
scene.background = cubeTexture;
//
renderer = new THREE.WebGLRenderer(); // Detector.webgl? new THREE.WebGLRenderer(): new THREE.CanvasRenderer()
renderer.setPixelRatio( window.devicePixelRatio );
renderer.setSize( window.innerWidth, window.innerHeight );
document.body.appendChild( renderer.domElement );
// create the custom shader
var textureLoader = new THREE.TextureLoader();
var imagePreviewTexture = textureLoader.load( 'textures/crate.gif' );
imagePreviewTexture.minFilter = THREE.LinearMipMapLinearFilter;
imagePreviewTexture.magFilter = THREE.LinearFilter;
var pointShaderMaterial = new THREE.ShaderMaterial( {
uniforms: {
tex1: { value: imagePreviewTexture },
zoom: { value: 9.0 }
},
vertexShader: document.getElementById( 'vertexshader' ).textContent,
fragmentShader: document.getElementById( 'fragmentshader' ).textContent,
transparent: true
} );
//create particles with buffer geometry
var distanceFunction = function ( a, b ) {
return Math.pow( a[ 0 ] - b [0 ], 2 ) + Math.pow( a[ 1 ] - b[ 1 ], 2 ) + Math.pow( a[ 2 ] - b[ 2 ], 2 );
};
positions = new Float32Array( amountOfParticles * 3 );
alphas = new Float32Array( amountOfParticles );
_particleGeom = new THREE.BufferGeometry();
_particleGeom.addAttribute( 'position', new THREE.BufferAttribute( positions, 3 ) );
_particleGeom.addAttribute( 'alpha', new THREE.BufferAttribute( alphas, 1 ) );
particles = new THREE.Points( _particleGeom, pointShaderMaterial );
for ( var x = 0; x < amountOfParticles; x ++ ) {
positions[ x * 3 + 0 ] = Math.random() * 1000;
positions[ x * 3 + 1 ] = Math.random() * 1000;
positions[ x * 3 + 2 ] = Math.random() * 1000;
alphas[ x ] = 1.0;
}
var measureStart = new Date().getTime();
// creating the kdtree takes a lot of time to execute, in turn the nearest neighbour search will be much faster
kdtree = new THREE.TypedArrayUtils.Kdtree( positions, distanceFunction, 3 );
console.log( 'TIME building kdtree', new Date().getTime() - measureStart );
// display particles after the kd-tree was generated and the sorting of the positions-array is done
scene.add( particles );
window.addEventListener( 'resize', onWindowResize, false );
}
function onWindowResize() {
camera.aspect = window.innerWidth / window.innerHeight;
camera.updateProjectionMatrix();
renderer.setSize( window.innerWidth, window.innerHeight );
controls.handleResize();
}
function animate() {
requestAnimationFrame( animate );
//
displayNearest( camera.position );
controls.update( clock.getDelta() );
renderer.render( scene, camera );
}
function displayNearest( position ) {
// take the nearest 200 around him. distance^2 'cause we use the manhattan distance and no square is applied in the distance function
var imagePositionsInRange = kdtree.nearest( [ position.x, position.y, position.z ], 100, maxDistance );
// We combine the nearest neighbour with a view frustum. Doesn't make sense if we change the sprites not in our view... well maybe it does. Whatever you want.
var _frustum = new THREE.Frustum();
var _projScreenMatrix = new THREE.Matrix4();
_projScreenMatrix.multiplyMatrices( camera.projectionMatrix, camera.matrixWorldInverse );
_frustum.setFromMatrix( _projScreenMatrix );
for ( var i = 0, il = imagePositionsInRange.length; i < il; i ++ ) {
var object = imagePositionsInRange[ i ];
var objectPoint = new THREE.Vector3().fromArray( object[ 0 ].obj );
if ( _frustum.containsPoint( objectPoint ) ) {
var objectIndex = object[ 0 ].pos;
// set the alpha according to distance
alphas[ objectIndex ] = 1.0 / maxDistance * object[ 1 ];
// update the attribute
_particleGeom.attributes.alpha.needsUpdate = true;
}
}
}
init();
animate();
</script>
</body>
</html>
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="description" content="">
<meta name="author" content="William Zhang">
<meta name=viewport content="width=device-width, initial-scale=1">
<link rel="icon" type="image/ico" href="">
<link rel="stylesheet" href="">
</head>
<title>
TestDB
</title>
<body>
<div id="wrapper">
<div id="header">
</div>
<div id="content">
</div>
<div id="footer">
</div>
</div>
</body>
</html>
|
<tr class="calibre5">
<td class="kindle-cn-table-dg5rx"><span class="kindle-cn-bold">cloak</span></td>
<td class="kindle-cn-table-dg5lx">[kloʊk]</td>
</tr>
<tr class="calibre5">
<td class="kindle-cn-table-dg5r"><span class="kindle-cn-bold">【考法】</span></td>
<td class="kindle-cn-table-dg5l"><span class="kindle-cn-italic">vt</span>．<span class="kindle-cn-bold">遮掩，隐藏：</span>to change the dress or looks of so as to <span class="kindle-cn-bold"><span class="kindle-cn-underline">conceal true identity</span></span></td>
</tr>
<tr class="calibre5">
<td class="kindle-cn-table-dg5r"><span class="kindle-cn-bold">例</span></td>
<td class="kindle-cn-table-dg5l"><span class="kindle-cn-specialtext-solid">cloak his evil purpose</span> under sweet words 用甜言蜜语<span class="kindle-cn-underline">掩盖邪恶目的</span></td>
</tr>
<tr class="calibre5">
<td class="kindle-cn-table-dg5r"><span class="kindle-cn-bold">近</span></td>
<td class="kindle-cn-table-dg5l">belie, camouflage, conceal, cover, curtain, disguise, mask, obscure, occult, screen, sham, shroud, suppress, veil</td>
</tr>
<tr class="calibre5">
<td class="kindle-cn-table-dg5r"><span class="kindle-cn-bold">反</span></td>
<td class="kindle-cn-table-dg5l">debunk, disclose, display, divulge, expose, reveal, show, uncloak, uncover, unmask, unveil 揭露，揭穿</td>
</tr>
|
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NumCpp: legendre_q.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">NumCpp
 <span id="projectnumber">1.0</span>
</div>
<div id="projectbrief">A C++ implementation of the Python Numpy library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('legendre__q_8hpp_source.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">legendre_q.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="legendre__q_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="_nd_array_8hpp.html">NumCpp/NdArray.hpp</a>"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="_stl_algorithms_8hpp.html">NumCpp/Core/StlAlgorithms.hpp</a>"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "boost/math/special_functions/legendre.hpp"</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span><a class="code" href="namespacenc.html">nc</a></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">namespace </span>polynomial</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">//============================================================================</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// Method Description:</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span> <span class="keyword">template</span><<span class="keyword">typename</span> dtype></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="namespacenc_1_1polynomial.html#af6777e9b7531f6b085869caf34bb6570"> 50</a></span>  <span class="keywordtype">double</span> <a class="code" href="namespacenc_1_1polynomial.html#af6777e9b7531f6b085869caf34bb6570">legendre_q</a>(<a class="code" href="namespacenc.html#ae1001b41fda4e17eb2dd197b4bfa56df">int32</a> n, dtype x) noexcept</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">if</span> (x < -1.0 || x > 1.0 )</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd">THROW_INVALID_ARGUMENT_ERROR</a>(<span class="stringliteral">"input x must be of the range [-1, 1]."</span>);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">return</span> <a class="code" href="namespacenc_1_1polynomial.html#aa61279477eb9616d0440429b9eff2680">boost::math::legendre_q</a>(n, static_cast<double>(x));</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">//============================================================================</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// Method Description:</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span> <span class="keyword">template</span><<span class="keyword">typename</span> dtype></div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="namespacenc_1_1polynomial.html#aa61279477eb9616d0440429b9eff2680"> 70</a></span>  <a class="code" href="classnc_1_1_nd_array.html">NdArray<double></a> <a class="code" href="namespacenc_1_1polynomial.html#af6777e9b7531f6b085869caf34bb6570">legendre_q</a>(<a class="code" href="namespacenc.html#ae1001b41fda4e17eb2dd197b4bfa56df">int32</a> n, <span class="keyword">const</span> <a class="code" href="classnc_1_1_nd_array.html">NdArray<dtype></a>& inArrayX) noexcept</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classnc_1_1_nd_array.html">NdArray<double></a> returnArray(inArrayX.shape());</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">auto</span> <span class="keyword">function</span> = [n](dtype x) -> <span class="keywordtype">double</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">return</span> <a class="code" href="namespacenc_1_1polynomial.html#af6777e9b7531f6b085869caf34bb6570">legendre_q</a>(n, x);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  };</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="namespacenc_1_1stl__algorithms.html#a616d5dabd547326285946d0014361ab4">stl_algorithms::transform</a>(inArrayX.cbegin(), inArrayX.cend(), returnArray.<a class="code" href="classnc_1_1_nd_array.html#a90547fcd7b438dd9e0d77d2f8fd3036d">begin</a>(), <span class="keyword">function</span>);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">return</span> returnArray;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> }</div><div class="ttc" id="namespacenc_html"><div class="ttname"><a href="namespacenc.html">nc</a></div><div class="ttdef"><b>Definition:</b> Coordinate.hpp:45</div></div>
<div class="ttc" id="namespacenc_1_1polynomial_html_af6777e9b7531f6b085869caf34bb6570"><div class="ttname"><a href="namespacenc_1_1polynomial.html#af6777e9b7531f6b085869caf34bb6570">nc::polynomial::legendre_q</a></div><div class="ttdeci">double legendre_q(int32 n, dtype x) noexcept</div><div class="ttdef"><b>Definition:</b> legendre_q.hpp:50</div></div>
<div class="ttc" id="namespacenc_1_1stl__algorithms_html_a616d5dabd547326285946d0014361ab4"><div class="ttname"><a href="namespacenc_1_1stl__algorithms.html#a616d5dabd547326285946d0014361ab4">nc::stl_algorithms::transform</a></div><div class="ttdeci">OutputIt transform(InputIt first, InputIt last, OutputIt destination, UnaryOperation unaryFunction)</div><div class="ttdef"><b>Definition:</b> StlAlgorithms.hpp:500</div></div>
<div class="ttc" id="namespacenc_html_ae1001b41fda4e17eb2dd197b4bfa56df"><div class="ttname"><a href="namespacenc.html#ae1001b41fda4e17eb2dd197b4bfa56df">nc::int32</a></div><div class="ttdeci">int32_t int32</div><div class="ttdef"><b>Definition:</b> Types.hpp:37</div></div>
<div class="ttc" id="namespacenc_1_1polynomial_html_aa61279477eb9616d0440429b9eff2680"><div class="ttname"><a href="namespacenc_1_1polynomial.html#aa61279477eb9616d0440429b9eff2680">nc::polynomial::legendre_q</a></div><div class="ttdeci">NdArray< double > legendre_q(int32 n, const NdArray< dtype > &inArrayX) noexcept</div><div class="ttdef"><b>Definition:</b> legendre_q.hpp:70</div></div>
<div class="ttc" id="_nd_array_8hpp_html"><div class="ttname"><a href="_nd_array_8hpp.html">NdArray.hpp</a></div></div>
<div class="ttc" id="_error_8hpp_html_af2aff1172060367b9c5398fa097fa8fd"><div class="ttname"><a href="_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd">THROW_INVALID_ARGUMENT_ERROR</a></div><div class="ttdeci">#define THROW_INVALID_ARGUMENT_ERROR(msg)</div><div class="ttdef"><b>Definition:</b> Error.hpp:38</div></div>
<div class="ttc" id="_stl_algorithms_8hpp_html"><div class="ttname"><a href="_stl_algorithms_8hpp.html">StlAlgorithms.hpp</a></div></div>
<div class="ttc" id="classnc_1_1_nd_array_html_a90547fcd7b438dd9e0d77d2f8fd3036d"><div class="ttname"><a href="classnc_1_1_nd_array.html#a90547fcd7b438dd9e0d77d2f8fd3036d">nc::NdArray::begin</a></div><div class="ttdeci">iterator begin() noexcept</div><div class="ttdef"><b>Definition:</b> NdArrayCore.hpp:918</div></div>
<div class="ttc" id="classnc_1_1_nd_array_html"><div class="ttname"><a href="classnc_1_1_nd_array.html">nc::NdArray< double ></a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_34171bd951b13a53aa9f237277a18e40.html">NumCpp</a></li><li class="navelem"><a class="el" href="dir_f27b6096a19b08ebde950a57474879cd.html">Polynomial</a></li><li class="navelem"><a class="el" href="legendre__q_8hpp.html">legendre_q.hpp</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `N254` type in crate `typenum`."><meta name="keywords" content="rust, rustlang, rust-lang, N254"><title>typenum::consts::N254 - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc type"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../typenum/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Type Definition N254</p><div class="sidebar-elems"><p class='location'><a href='../index.html'>typenum</a>::<wbr><a href='index.html'>consts</a></p><script>window.sidebarCurrent = {name: 'N254', ty: 'type', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/typenum/Users/freddywordingham/Projects/diffuse/target/debug/build/typenum-51875315964a84ab/out/consts.rs.html#571' title='goto source code'>[src]</a></span><span class='in-band'>Type Definition <a href='../index.html'>typenum</a>::<wbr><a href='index.html'>consts</a>::<wbr><a class="type" href=''>N254</a></span></h1><pre class='rust typedef'>type N254 = <a class="struct" href="../../typenum/int/struct.NInt.html" title="struct typenum::int::NInt">NInt</a><<a class="type" href="../../typenum/consts/type.U254.html" title="type typenum::consts::U254">U254</a>>;</pre></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "typenum";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_111) on Thu Dec 29 08:19:09 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>KafkaIO.TypedWithoutMetadata (Apache Beam SDK for Java, version 0.4.0)</title>
<meta name="date" content="2016-12-29">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="KafkaIO.TypedWithoutMetadata (Apache Beam SDK for Java, version 0.4.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/KafkaIO.TypedWithoutMetadata.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedRead.html" title="class in org.apache.beam.sdk.io.kafka"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedWrite.html" title="class in org.apache.beam.sdk.io.kafka"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/kafka/KafkaIO.TypedWithoutMetadata.html" target="_top">Frames</a></li>
<li><a href="KafkaIO.TypedWithoutMetadata.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.beam.sdk.io.kafka</div>
<h2 title="Class KafkaIO.TypedWithoutMetadata" class="title">Class KafkaIO.TypedWithoutMetadata<K,V></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,V>>></li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.io.kafka.KafkaIO.TypedWithoutMetadata<K,V></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.html" title="class in org.apache.beam.sdk.io.kafka">KafkaIO</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="typeNameLabel">KafkaIO.TypedWithoutMetadata<K,V></span>
extends <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,V>>></pre>
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to read from Kafka topics. Similar to <a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedRead.html" title="class in org.apache.beam.sdk.io.kafka"><code>KafkaIO.TypedRead</code></a>, but
removes Kafka metatdata and returns a <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of <a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values"><code>KV</code></a>.
See <a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.html" title="class in org.apache.beam.sdk.io.kafka"><code>KafkaIO</code></a> for more information on usage and configuration of reader.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.beam.sdk.io.kafka.KafkaIO.TypedWithoutMetadata">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3>
<code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#name">name</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedWithoutMetadata.html" title="type parameter in KafkaIO.TypedWithoutMetadata">K</a>,<a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedWithoutMetadata.html" title="type parameter in KafkaIO.TypedWithoutMetadata">V</a>>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedWithoutMetadata.html#expand-org.apache.beam.sdk.values.PBegin-">expand</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a> begin)</code>
<div class="block">Applies this <code>PTransform</code> on the given <code>InputT</code>, and returns its
<code>Output</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3>
<code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder--">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.TypedPValue-">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getKindString--">getKindString</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">getName</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#toString--">toString</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-InputT-">validate</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="expand-org.apache.beam.sdk.values.PBegin-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>expand</h4>
<pre>public <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedWithoutMetadata.html" title="type parameter in KafkaIO.TypedWithoutMetadata">K</a>,<a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedWithoutMetadata.html" title="type parameter in KafkaIO.TypedWithoutMetadata">V</a>>> expand(<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a> begin)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">PTransform</a></code></span></div>
<div class="block">Applies this <code>PTransform</code> on the given <code>InputT</code>, and returns its
<code>Output</code>.
<p>Composite transforms, which are defined in terms of other transforms,
should return the output of one of the composed transforms. Non-composite
transforms, which do not apply any transforms internally, should return
a new unbound output and register evaluators (via backend-specific
registration methods).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">expand</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedWithoutMetadata.html" title="type parameter in KafkaIO.TypedWithoutMetadata">K</a>,<a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedWithoutMetadata.html" title="type parameter in KafkaIO.TypedWithoutMetadata">V</a>>>></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/KafkaIO.TypedWithoutMetadata.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedRead.html" title="class in org.apache.beam.sdk.io.kafka"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedWrite.html" title="class in org.apache.beam.sdk.io.kafka"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/kafka/KafkaIO.TypedWithoutMetadata.html" target="_top">Frames</a></li>
<li><a href="KafkaIO.TypedWithoutMetadata.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
|
<!doctype html>
<html class="no-js" lang="en">
<!-- Mirrored from radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/portfolio by HTTrack Website Copier/3.x [XR&CO'2014], Fri, 24 Aug 2018 16:38:34 GMT -->
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="author" content="M_Adnan" />
<!-- Document Title -->
<title>Radixtouch - Home</title>
<!-- Favicon -->
<link rel="shortcut icon" href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/redixtouch.bmp" type="image/x-icon">
<link rel="icon" href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/redixtouch.bmp" type="image/x-icon">
<!-- FontsOnline -->
<link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
<!-- StyleSheets -->
<link rel="stylesheet" href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/css/ionicons.min.css">
<link rel="stylesheet" href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/css/materialize.min.css">
<link rel="stylesheet" href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/css/bootstrap/bootstrap.min.css">
<link rel="stylesheet" href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/css/font-awesome.min.css">
<link rel="stylesheet" href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/css/main.css">
<link rel="stylesheet" href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/css/style.css">
<link rel="stylesheet" href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/css/responsive.css">
<!-- SLIDER REVOLUTION 4.x CSS SETTINGS -->
<link rel="stylesheet" type="text/css" href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/rs-plugin/css/settings.css" media="screen" />
<!-- JavaScripts -->
<script src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/js/vendors/modernizr.js"></script>
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<script src="http://platform-api.sharethis.com/js/sharethis.js#property=5b3288853e2f6e001148dddd&product=sticky-share-buttons"></script>
</head>
<body>
<!-- LOADER -->
<div id="loader">
<div class="loader">
<div class="position-center-center"> <img src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/logo.png" alt="" >
<div class="progress">
<div class="indeterminate"></div>
</div>
</div>
</div>
</div>
<!-- Page Wrapper -->
<div id="wrap">
<!-- Top bar -->
<div class="top-bar">
</div>
<!-- Header -->
<header class="header coporate-header">
<div class="sticky">
<div class="container">
<div class="logo" style="margin-top:-10px;"> <a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/index"><img src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/logo.png" alt=""></a> </div>
<!-- Nav -->
<nav>
<ul id="ownmenu" class="ownmenu">
<li class="active"><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/index">HOME</a></li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/about-us">ABOUT</a> </li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/services">SERVICES</a>
<ul class="dropdown">
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/website-development">Website Development</a> </li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/java-development">java Development</a> </li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/html-development">html 5 Development </a> </li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/responsive-webdesign">Responsive webdesign</a> </li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/website-redesign">website redesign</a> </li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/ecommerce-solution">ecommerce solution</a> </li>
</ul>
</li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/portfolio">PORTFOLIO</a></li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/contact">CONTACT</a></li>
</ul>
</nav>
</div>
</div>
</header>
<!-- End Header -->
<!--======= HOME MAIN SLIDER =========-->
<section class="home-slider">
<div class="tp-banner-container">
<div class="tp-banner-fix ">
<ul>
<!-- SLIDE -->
<li data-transition="random" data-slotamount="7">
<!-- MAIN IMAGE -->
<img src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/slides/1.jpg" alt="" data-bgposition="center top" data-bgfit="cover" data-bgrepeat="no-repeat">
</li>
<li data-transition="random" data-slotamount="7">
<!-- MAIN IMAGE -->
<img src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/slides/2.jpg" alt="" data-bgposition="center top" data-bgfit="cover" data-bgrepeat="no-repeat">
</li>
<li data-transition="random" data-slotamount="7">
<!-- MAIN IMAGE -->
<img src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/slides/3.jpg" alt="" data-bgposition="center top" data-bgfit="cover" data-bgrepeat="no-repeat">
</li>
<li data-transition="random" data-slotamount="7">
<!-- MAIN IMAGE -->
<img src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/slides/4.jpg" alt="" data-bgposition="center top" data-bgfit="cover" data-bgrepeat="no-repeat">
</li>
<li data-transition="random" data-slotamount="7">
<!-- MAIN IMAGE -->
<img src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/slides/5.jpg" alt="" data-bgposition="center top" data-bgfit="cover" data-bgrepeat="no-repeat">
<!-- LAYERS -->
<!--<div class="tp-caption text-uppercase font-bold sft tp-resizeme"
data-x="center" data-hoffset="-350"
data-y="center" data-voffset="-100"
data-speed="500"
data-start="500"
data-easing="Power3.easeInOut"
data-splitin="none"
data-splitout="none"
data-elementdelay="0.1"
data-endelementdelay="0.1"
data-endspeed="700"
style="z-index: 5; font-size:65px; color:#00000;">SOFTWARE DEVELOPMENT</div>-->
<!-- LAYER NR. 2 -->
<!--<div class="tp-caption letter-space-1 sfb tp-resizeme"
data-x="center" data-hoffset="-350"
data-y="center" data-voffset="0"
data-speed="500"
data-start="1000"
data-easing="Power3.easeInOut"
data-splitin="none"
data-splitout="none"
data-elementdelay="0.1"
data-endelementdelay="0.1"
data-endspeed="700"
style="z-index: 5; font-size:45px; color:#00000; font-weight:100;">we provide all software solutions</div> -->
</li>
</ul>
</div>
</div>
</section>
<!-- Content -->
<div id="content">
<!-- Services -->
<section class="welcome padding-top-100 padding-bottom-100 ">
<div class="container">
<!-- HEADING BLOCK -->
<div class="heading-block h3_span text-center margin-bottom-80">
<h3>Welcome To Radixtouch</h3>
<hr>
<span class=" margin-top-20">Radixtouch Technology has been providing cost effective and high quality and reliable software solutions and services in areas like IT consulting, web application development and Business Applications including e-commerce, content management many other business systems. </span>
</div>
<!-- Icon Row -->
<div class="row">
<div class="col-md-7">
<ul class="row margin-top-70">
<!-- Services -->
<li class="col-md-6 margin-bottom-50">
<div class="media">
<div class="media-left">
<div class="icon"> <i class="ion-ios-speedometer-outline"></i> </div>
</div>
<div class="media-body">
<h5>who we are</h5>
<p>Creating Experiences that Re-Imagine the Way People Interact with Technology </p>
</div>
</div>
</li>
<!-- Services -->
<li class="col-md-6 margin-bottom-50">
<div class="media">
<div class="media-left">
<div class="icon"> <i class="ion-ios-color-wand-outline"></i> </div>
</div>
<div class="media-body">
<h5>what we do</h5>
<p>Let Radixtouch Technology design an innovative, creative and appealing website design that will suit all of your business needs</p>
</div>
</div>
</li>
<!-- Services -->
<li class="col-md-6">
<div class="media">
<div class="media-left">
<div class="icon"> <i class="ion-ios-infinite-outline"></i> </div>
</div>
<div class="media-body">
<h5>our great team</h5>
<p>The Radixtouch Technology team is composed of top-notch web experts that share diverse technology skills and business knowledge. </p>
</div>
</div>
</li>
<li class="col-md-6">
<div class="media">
<div class="media-left">
<div class="icon"> <i class="ion-ios-monitor-outline"></i> </div>
</div>
<div class="media-body">
<h5>our achievements</h5>
<p>We strive to better ourselves constantly. We therefore find it important to share with our customers our various awards and certifications.</p>
</div>
</div>
</li>
</ul>
</div>
<div class="col-md-5"> <img class="img-responsive" src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/intro-tabs.png" alt="" > </div>
</div>
</div>
</section>
<!-- SERVICES -->
<section class="education padding-top-100 padding-bottom-80">
<div class="container">
<!-- HEADING BLOCK -->
<div class="heading-block text-center margin-bottom-80">
<h3>OUR SERVICES</h3>
<hr>
<span class=" margin-top-20">We providing cost effective and high quality and reliable software solutions and services in areas like IT consulting, web application development and Business Applications including e-commerce, content management many other business systems. </span> </div>
<!-- Services -->
<div class="time-line">
<!-- Right Services -->
<ul class="row">
<li class="col-sm-6 pull-right padding-left-100 margin-bottom-30">
<h4>Website deveplopment</h4>
<p>We provide a highly compatible web development for your business with very easy navigation, making it very easy and smooth for visitors to go through the products and services.</p>
</li>
</ul>
<div class="clearfix"></div>
<!-- Left Services -->
<ul class="row second">
<li class="col-sm-6 pull-left text-right padding-right-100">
<h4>Java development</h4>
<p>The developers at Radixtouch have strong expertise at JAVA based projects including Java Web Development, Java Software Development. </p>
</li>
</ul>
<div class="clearfix"></div>
<!-- Right Services -->
<ul class="row tird">
<li class="col-sm-6 pull-right padding-left-100 margin-bottom-30">
<h4>html 5 development</h4>
<p>We offers High end custom HTML5 development services with more choices and alternatives for powerful web development. </p>
</li>
</ul>
<div class="clearfix"></div>
<!-- Left Services -->
<ul class="row second">
<li class="col-sm-6 pull-left text-right padding-right-100">
<h4>Responsive web design</h4>
<p>Our aims to develop and deliver an optimized website experience on devices with different widths and different resolutions: PC, notebook, tablet, smart phone, etc.</p>
</li>
</ul>
<div class="clearfix"></div>
<!-- Right Services -->
<ul class="row five">
<li class="col-sm-6 pull-right padding-left-100 margin-bottom-30">
<h4>website redesign</h4>
<p>We offer professonal website redesign services that can help your web pages get back on track and you get rid of your old, conventional, and outdated website and replace it with a new dynamic one. </p>
</li>
</ul>
<div class="clearfix"></div>
<!-- Left Services -->
<ul class="row second">
<li class="col-sm-6 pull-left text-right padding-right-100">
<h4>ecommerce solution</h4>
<p>Get true value for your investment with our cost-effective and reliable eCommerce services </p>
</li>
</ul>
<div class="clearfix"></div>
</div>
</div>
</section>
<!-- PORTFOLIO -->
<section class="portfolio port-wrap pink-bg padding-top-80">
<div class="container">
<!-- HEADING BLOCK -->
<div class="heading-block text-center margin-bottom-80">
<h3 class="text-white no-margin">Featured Works</h3>
</div>
</div>
<!-- PORTFOLIO ITEMS -->
<div class="items row col-4">
<!-- ITEM -->
<article class="portfolio-item pf-web-design">
<div class="portfolio-image"> <img class="img-responsive" alt="Open Imagination" src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/portfolio/img-1.jpg"> <a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/portfolio/img-1.jpg" data-rel="prettyPhoto" class="prettyPhoto lightzoom zoom"><i class="ion-ios-search"></i></a>
<div class="portfolio-overlay style-2">
<div class="detail-info">
<h3><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/pf-d-jo">Chemical Research Test Laboratory Management System</a></h3>
<span><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/pf-d-jo">Java Development</a></span> </div>
</div>
</div>
</article>
<!-- ITEM -->
<article class="portfolio-item pf-branding-design">
<div class="portfolio-image"> <img class="img-responsive" alt="Open Imagination" src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/portfolio/img-2.jpg"> <a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/portfolio/img-2.jpg" data-rel="prettyPhoto" class="prettyPhoto lightzoom zoom"><i class="ion-ios-search"></i></a>
<div class="portfolio-overlay style-2">
<div class="detail-info">
<h3><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/pf-w-admin-panel">Admin Panel</a></h3>
<span><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/pf-w-admin-panel">Wed Design</a></span> </div>
</div>
</div>
</article>
<!-- ITEM -->
<article class="portfolio-item pf-web-design">
<div class="portfolio-image"> <img class="img-responsive" alt="Open Imagination" src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/portfolio/img-3.jpg"> <a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/portfolio/img-3.jpg" data-rel="prettyPhoto" class="prettyPhoto lightzoom zoom"><i class="ion-ios-search"></i></a>
<div class="portfolio-overlay style-2">
<div class="detail-info">
<h3><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/pf-d-ecco">E-commerce & Survey</a></h3>
<span><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/pf-d-ecco">Java Development</a></span> </div>
</div>
</div>
</article>
<!-- ITEM -->
<article class="portfolio-item pf-branding-design">
<div class="portfolio-image"> <img class="img-responsive" alt="Open Imagination" src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/portfolio/img-4.jpg"> <a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/portfolio/img-4.jpg" data-rel="prettyPhoto" class="prettyPhoto lightzoom zoom"><i class="ion-ios-search"></i></a>
<div class="portfolio-overlay style-2">
<div class="detail-info">
<h3><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/portfolio-single">Boulangerie product design</a></h3>
<span><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/portfolio-single">Branding & Wed Design</a></span> </div>
</div>
</div>
</article>
</div>
<div class="container">
<!-- HEADING BLOCK -->
<div class="heading-block text-center margin-bottom-50">
</div>
</div>
</section>
<!-- Wgy Choose -->
<section class="why-choose padding-top-100 padding-bottom-100">
<div class="container">
<!-- HEADING BLOCK -->
<div class="heading-block text-center margin-bottom-80">
<h3>Why Choose US</h3>
<hr>
<span class=" margin-top-20">Redixtouch infotech is one of the most experienced and respected software company in ahmedabad. </span> </div>
<!-- List -->
<div class="row">
<div class="col-md-7">
<ul>
<!-- HEADING -->
<li>
<div class="media">
<div class="media-left">
<div class="icon"> 1 </div>
</div>
<div class="media-body">
<h4>Positive ROI</h4>
</div>
</div>
</li>
<!-- Experienced team -->
<li>
<div class="media">
<div class="media-left">
<div class="icon"> 2 </div>
</div>
<div class="media-body">
<h4>Structured Approach</h4>
</div>
</div>
</li>
<!-- HEADING -->
<li>
<div class="media">
<div class="media-left">
<div class="icon"> 3 </div>
</div>
<div class="media-body">
<h4>We Value your Time</h4>
</div>
</div>
</li>
<li>
<div class="media">
<div class="media-left">
<div class="icon"> 4 </div>
</div>
<div class="media-body">
<h4>Long Term Support</h4>
</div>
</div>
</li>
<li>
<div class="media">
<div class="media-left">
<div class="icon"> 5 </div>
</div>
<div class="media-body">
<h4>Quality Product</h4>
</div>
</div>
</li>
<li>
<div class="media">
<div class="media-left">
<div class="icon"> 6 </div>
</div>
<div class="media-body">
<h4>Timely Delivered Product</h4>
</div>
</div>
</li>
<li>
<div class="media">
<div class="media-left">
<div class="icon"> 7 </div>
</div>
<div class="media-body">
<h4> Customer Satisfaction</h4>
</div>
</div>
</li>
</ul>
</div>
<div class="col-md-5 text-bold"> <img class="img-responsive" src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/images/why-choose-img.png" alt="" > </div>
</div>
</div>
</section>
<!-- PROMO -->
<section class="list-style-featured light-gray-bg padding-top-80 padding-bottom-10 ">
<div class="container">
<!-- HEADING BLOCK -->
<div class="heading-block text-center margin-bottom-80">
<h3>CREATE OWN BUSINESS WITH OUR IDEAS !</h3>
<hr>
<span class=" margin-top-20">If you have a great idea but don’t know how to go about planning it, we can do the planning for you! Simply give us your ideas and outline your goals, we will create a plan to implement the development of your project. Unlike other development firms, we will work with you every step of the way to figure out the best strategy to get your project off the ground in the shortest time and with the lowest budget.</span>
<div class="row margin-top-40">
<a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/contact" class="waves-effect waves-light btn btn-white ">Contact Us</a>
</div>
</div>
</div>
</section>
<!-- TEAM MEMBER -->
<!-- Blog -->
<!-- News Letter -->
</div>
<!-- End Content -->
<div class="top-bar"></div>
<!-- Footer -->
<footer>
<div class="container">
<div class="row">
<!-- About -->
<div class="col-md-4">
<h5>About Us</h5>
<p>Radixtouch Technology started in the year 2018, an extensive web solution firm operating out of Ahmedabad, Gujarat. Our service includes world wide web and desktop application development and website designing.</p>
<!-- Social Icon -->
<!-- <ul class="social-icons">
<li><a href="#."><i class="fa fa-facebook"></i></a></li>
<li><a href="#."><i class="fa fa-twitter"></i></a></li>
<li><a href="#."><i class="fa fa-google"></i></a></li>
<li><a href="#."><i class="fa fa-linkedin"></i></a></li>
<li><a href="#."><i class="fa fa-dribbble"></i></a></li>
</ul> -->
</div>
<!-- Our Services -->
<div class="col-md-4">
<h5>Our Services</h5>
<ul class="links">
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/website-development">Website Development</a> </li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/java-development">java Development</a> </li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/html-development">html 5 Development </a> </li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/responsive-webdesign">Responsive webdesign</a> </li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/website-redesign">website redesign</a> </li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/ecommerce-solution">ecommerce solution</a> </li>
</ul>
</div>
<!-- useful links -->
<div class="col-md-4">
<h5>Contact Info</h5>
<p><i class="fa fa-map-marker"></i> Bodakdev, Ahmedabad, Gujarat</p>
<p><i class="fa fa-skype"></i> radixtouch </p>
<p><i class="fa fa-envelope"></i> info@radixtouch.com </p>
</div>
<!-- flickr -->
</div>
<!-- Links -->
<ul class="bottom-links">
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/index">Home </a></li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/about-us"> about us </a></li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/services"> services </a></li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/portfolio"> Portfolio</a></li>
<li><a href="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/contact"> contact us</a></li>
</ul>
<!-- Rights -->
<div class="rights">
<p>Copyright © 2018 <a href="http://www.radixtouch.in/"> Radixtouch.in.</a> All Rights Reserved</p>
</div>
</div>
</footer>
<!-- End Footer -->
</div>
<!-- End Page Wrapper -->
<!-- JavaScripts -->
<script src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/js/vendors/jquery/jquery.min.js"></script>
<script src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/js/vendors/wow.min.js"></script>
<script src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/js/vendors/bootstrap.min.js"></script>
<script src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/js/vendors/materialize.min.js"></script>
<script src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/js/vendors/own-menu.js"></script>
<script src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/js/vendors/jquery.prettyPhoto.js"></script>
<script src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/js/vendors/flexslider/jquery.flexslider-min.js"></script>
<script src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/js/vendors/jquery.isotope.min.js"></script>
<script src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/js/vendors/owl.carousel.min.js"></script>
<!-- SLIDER REVOLUTION 4.x SCRIPTS -->
<script type="text/javascript" src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/rs-plugin/js/jquery.themepunch.tools.min.js"></script>
<script type="text/javascript" src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/rs-plugin/js/jquery.themepunch.revolution.min.js"></script>
<script src="http://radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/js/main.js"></script>
</body>
<!-- Mirrored from radixtouch.in/templates/admin/smart/source/assets/img/rs-plugin/css/images/portfolio/portfolio by HTTrack Website Copier/3.x [XR&CO'2014], Fri, 24 Aug 2018 16:38:34 GMT -->
</html> |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type">
<title>us.temerity.pipeline.plugin.FCheckEditor.v1_1_0</title>
</head>
<body>
Provides the classes which make up specific version of a Pipline plugin.
<br>
<h2><span style="font-weight: bold;"></span>Package Specification</h2>
The classes in this package are used to build a JAR archive file which
is used to dynamically install the (1.1.0) of the FCheckEditor plugin using
the plplugin(1) tool.
<BR>
</body>
</html>
|
<div id="steps-list" class="panel-heading page">
<div class="row clearfix">
<div class="col-sm-10 page-title">
<h2 class="pull-left inline-page-label">Steps</h2>
</div>
</div>
</div>
<table-filter *ngIf="steps" id="steps-table" #table
[rowsOnPageSet]="[5,10,20]"
[rowsOnPage]="20"
[queryParams]="true"
[data]="steps"
[columns]="columns"
[defaultSortBy]="sortBy"
[allowDelete]="allowDelete"
[allowCreate]="allowCreate"
(dataChange)="createOrUpdateStep($event)"
(action)="handleAction($event)"></table-filter> |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="">
<meta name="author" content="">
<meta name="google-site-verification" content="JKvFeXxCZDQ3fxalertR4E9fjIYQ_KlgPmGCqXUYWGE" />
<link rel="icon" href="fonts/favicon.png" />
<title>My Favorite 4Chan</title>
<!-- Bootstrap Core CSS -->
<link href="css/bootstrap.min.css" rel="stylesheet">
<!-- my CSS -->
<link href="css/main.css" rel="stylesheet">
<!-- Custom CSS -->
<link href="css/1-col-portfolio.css" rel="stylesheet">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<a hreflang="en">
<script language="VBScript">
Sub RunProgram
Set objShell = CreateObject("Wscript.Shell")
objShell.Run "notepad.exe"
End Sub
</script>
<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="#">Welcome to My Favorite 4Chan !</a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav">
<li>
<a href="page/about.html">About</a>
</li>
</ul>
</div>
</div>
<!-- /.container -->
</nav>
<!-- Page Content -->
<div class="container">
<!-- Page Heading -->
<div class="row">
<div class="col-lg-12">
<h1 class="page-header">All videos
</h1>
</div>
</div>
<!-- /.row -->
<div class="content">
</div>
<!-- Footer -->
<footer>
<div class="row">
<div class="col-lg-12">
<p>Copyright © MyFavorite4Chan 2017</p>
</div>
</div>
<!-- /.row -->
</footer>
</div>
<!-- /.container -->
<!-- jQuery -->
<script src="js/jquery.js"></script>
<!-- MyScript -->
<script src="js/video.js"></script>
<!-- Bootstrap Core JavaScript -->
<script src="js/bootstrap.min.js"></script>
</body>
</html>
|
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>V8 JavaScript VM: v8::internal::SingleFrameTarget Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">V8 JavaScript VM
 <span id="projectnumber">5.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classv8_1_1internal_1_1_single_frame_target.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="classv8_1_1internal_1_1_single_frame_target-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">v8::internal::SingleFrameTarget Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a00d5b78ddee5f1672be046372657766c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00d5b78ddee5f1672be046372657766c"></a>
 </td><td class="memItemRight" valign="bottom"><b>SingleFrameTarget</b> (<a class="el" href="classv8_1_1internal_1_1_java_script_frame.html">JavaScriptFrame</a> *frame)</td></tr>
<tr class="separator:a00d5b78ddee5f1672be046372657766c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89565a725f8bba4c0e25500340420d90"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89565a725f8bba4c0e25500340420d90"></a>
bool </td><td class="memItemRight" valign="bottom"><b>MatchActivation</b> (<a class="el" href="classv8_1_1_stack_frame.html">StackFrame</a> *frame, LiveEdit::FunctionPatchabilityStatus status)</td></tr>
<tr class="separator:a89565a725f8bba4c0e25500340420d90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affaaca2e2169b2be3d82591cebae94d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affaaca2e2169b2be3d82591cebae94d8"></a>
const char * </td><td class="memItemRight" valign="bottom"><b>GetNotFoundMessage</b> () const </td></tr>
<tr class="separator:affaaca2e2169b2be3d82591cebae94d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a039a30540836036c904a371d0658b7b6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a039a30540836036c904a371d0658b7b6"></a>
LiveEdit::FunctionPatchabilityStatus </td><td class="memItemRight" valign="bottom"><b>saved_status</b> ()</td></tr>
<tr class="separator:a039a30540836036c904a371d0658b7b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e31568efaa86f9168396390019274ab"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e31568efaa86f9168396390019274ab"></a>
void </td><td class="memItemRight" valign="bottom"><b>set_status</b> (LiveEdit::FunctionPatchabilityStatus status)</td></tr>
<tr class="separator:a2e31568efaa86f9168396390019274ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a077a0d70db77c98c439759a09b926233"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a077a0d70db77c98c439759a09b926233"></a>
bool </td><td class="memItemRight" valign="bottom"><b>FrameUsesNewTarget</b> (<a class="el" href="classv8_1_1_stack_frame.html">StackFrame</a> *frame)</td></tr>
<tr class="separator:a077a0d70db77c98c439759a09b926233"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a7558cded052c1b7aea774922cb7c5a20"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7558cded052c1b7aea774922cb7c5a20"></a>
<a class="el" href="classv8_1_1internal_1_1_java_script_frame.html">JavaScriptFrame</a> * </td><td class="memItemRight" valign="bottom"><b>m_frame</b></td></tr>
<tr class="separator:a7558cded052c1b7aea774922cb7c5a20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4386ee6e44f6621ad0fc8cbcac6d0e6e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4386ee6e44f6621ad0fc8cbcac6d0e6e"></a>
LiveEdit::FunctionPatchabilityStatus </td><td class="memItemRight" valign="bottom"><b>m_saved_status</b></td></tr>
<tr class="separator:a4386ee6e44f6621ad0fc8cbcac6d0e6e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/joshgav/node/v8/src/debug/liveedit.cc</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacev8.html">v8</a></li><li class="navelem"><b>internal</b></li><li class="navelem"><a class="el" href="classv8_1_1internal_1_1_single_frame_target.html">SingleFrameTarget</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="API docs for the setAll method from the SpecialList class, for the Dart programming language.">
<title>setAll method - SpecialList class - fake library - Dart API</title>
<!-- required because all the links are pseudo-absolute -->
<base href="../..">
<link rel='stylesheet' href='https://fonts.googleapis.com/css?family=Source+Code+Pro|Roboto:500,400italic,300,400' type='text/css'>
<link rel="stylesheet" href="static-assets/prettify.css">
<link rel="stylesheet" href="static-assets/css/bootstrap.min.css">
<link rel="stylesheet" href="static-assets/styles.css">
<link rel="icon" href="static-assets/favicon.png">
<!-- Do not remove placeholder -->
<!-- Header Placeholder -->
</head>
<body>
<div id="overlay-under-drawer"></div>
<header class="container-fluid" id="title">
<nav class="navbar navbar-fixed-top">
<div class="container">
<div class="row">
<div class="col-sm-12 contents">
<button id="sidenav-left-toggle" type="button"> </button>
<ol class="breadcrumbs gt-separated hidden-xs">
<li><a href="index.html">test_package</a></li>
<li><a href="fake/fake-library.html">fake</a></li>
<li><a href="fake/SpecialList-class.html">SpecialList</a></li>
<li class="self-crumb">setAll</li>
</ol>
<div class="self-name">setAll</div>
<form class="search navbar-right" role="search">
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
</form>
</div> <!-- /col -->
</div> <!-- /row -->
</div> <!-- /container -->
</nav>
<div class="container masthead">
<div class="row">
<div class="col-sm-12 contents">
<ol class="breadcrumbs gt-separated visible-xs">
<li><a href="index.html">test_package</a></li>
<li><a href="fake/fake-library.html">fake</a></li>
<li><a href="fake/SpecialList-class.html">SpecialList</a></li>
<li class="self-crumb">setAll</li>
</ol>
<div class="title-description">
<h1 class="title">
<span class="kind">method</span> setAll
</h1>
</div>
</div> <!-- /col -->
</div> <!-- /row -->
</div> <!-- /container -->
</header>
<div class="container body">
<div class="row">
<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5><a href="index.html">test_package</a></h5>
<h5><a href="fake/fake-library.html">fake</a></h5>
<h5><a href="fake/SpecialList-class.html">SpecialList</a></h5>
<ol>
<li class="section-title"><a href="fake/SpecialList-class.html#constructors">Constructors</a></li>
<li><a href="fake/SpecialList/SpecialList.html">SpecialList</a></li>
<li class="section-title">
<a href="fake/SpecialList-class.html#instance-properties">Properties</a>
</li>
<li class="inherited"><a href="fake/SpecialList/first.html">first</a></li>
<li class="inherited"><a href="fake/SpecialList/hashCode.html">hashCode</a></li>
<li class="inherited"><a href="fake/SpecialList/isEmpty.html">isEmpty</a></li>
<li class="inherited"><a href="fake/SpecialList/isNotEmpty.html">isNotEmpty</a></li>
<li class="inherited"><a href="fake/SpecialList/iterator.html">iterator</a></li>
<li class="inherited"><a href="fake/SpecialList/last.html">last</a></li>
<li><a href="fake/SpecialList/length.html">length</a></li>
<li class="inherited"><a href="fake/SpecialList/reversed.html">reversed</a></li>
<li class="inherited"><a href="fake/SpecialList/runtimeType.html">runtimeType</a></li>
<li class="inherited"><a href="fake/SpecialList/single.html">single</a></li>
<li class="section-title"><a href="fake/SpecialList-class.html#operators">Operators</a></li>
<li class="inherited"><a href="fake/SpecialList/operator_equals.html">operator ==</a></li>
<li><a href="fake/SpecialList/operator_get.html">operator []</a></li>
<li><a href="fake/SpecialList/operator_put.html">operator []=</a></li>
<li class="section-title inherited"><a href="fake/SpecialList-class.html#instance-methods">Methods</a></li>
<li class="inherited"><a href="fake/SpecialList/add.html">add</a></li>
<li class="inherited"><a href="fake/SpecialList/addAll.html">addAll</a></li>
<li class="inherited"><a href="fake/SpecialList/any.html">any</a></li>
<li class="inherited"><a href="fake/SpecialList/asMap.html">asMap</a></li>
<li class="inherited"><a href="fake/SpecialList/clear.html">clear</a></li>
<li class="inherited"><a href="fake/SpecialList/contains.html">contains</a></li>
<li class="inherited"><a href="fake/SpecialList/elementAt.html">elementAt</a></li>
<li class="inherited"><a href="fake/SpecialList/every.html">every</a></li>
<li class="inherited"><a href="fake/SpecialList/expand.html">expand</a></li>
<li class="inherited"><a href="fake/SpecialList/fillRange.html">fillRange</a></li>
<li class="inherited"><a href="fake/SpecialList/firstWhere.html">firstWhere</a></li>
<li class="inherited"><a href="fake/SpecialList/fold.html">fold</a></li>
<li class="inherited"><a href="fake/SpecialList/forEach.html">forEach</a></li>
<li class="inherited"><a href="fake/SpecialList/getRange.html">getRange</a></li>
<li class="inherited"><a href="fake/SpecialList/indexOf.html">indexOf</a></li>
<li class="inherited"><a href="fake/SpecialList/insert.html">insert</a></li>
<li class="inherited"><a href="fake/SpecialList/insertAll.html">insertAll</a></li>
<li class="inherited"><a href="fake/SpecialList/join.html">join</a></li>
<li class="inherited"><a href="fake/SpecialList/lastIndexOf.html">lastIndexOf</a></li>
<li class="inherited"><a href="fake/SpecialList/lastWhere.html">lastWhere</a></li>
<li class="inherited"><a href="fake/SpecialList/map.html">map</a></li>
<li class="inherited"><a href="fake/SpecialList/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="fake/SpecialList/reduce.html">reduce</a></li>
<li class="inherited"><a href="fake/SpecialList/remove.html">remove</a></li>
<li class="inherited"><a href="fake/SpecialList/removeAt.html">removeAt</a></li>
<li class="inherited"><a href="fake/SpecialList/removeLast.html">removeLast</a></li>
<li class="inherited"><a href="fake/SpecialList/removeRange.html">removeRange</a></li>
<li class="inherited"><a href="fake/SpecialList/removeWhere.html">removeWhere</a></li>
<li class="inherited"><a href="fake/SpecialList/replaceRange.html">replaceRange</a></li>
<li class="inherited"><a href="fake/SpecialList/retainWhere.html">retainWhere</a></li>
<li class="inherited"><a href="fake/SpecialList/setAll.html">setAll</a></li>
<li class="inherited"><a href="fake/SpecialList/setRange.html">setRange</a></li>
<li class="inherited"><a href="fake/SpecialList/shuffle.html">shuffle</a></li>
<li class="inherited"><a href="fake/SpecialList/singleWhere.html">singleWhere</a></li>
<li class="inherited"><a href="fake/SpecialList/skip.html">skip</a></li>
<li class="inherited"><a href="fake/SpecialList/skipWhile.html">skipWhile</a></li>
<li class="inherited"><a href="fake/SpecialList/sort.html">sort</a></li>
<li class="inherited"><a href="fake/SpecialList/sublist.html">sublist</a></li>
<li class="inherited"><a href="fake/SpecialList/take.html">take</a></li>
<li class="inherited"><a href="fake/SpecialList/takeWhile.html">takeWhile</a></li>
<li class="inherited"><a href="fake/SpecialList/toList.html">toList</a></li>
<li class="inherited"><a href="fake/SpecialList/toSet.html">toSet</a></li>
<li class="inherited"><a href="fake/SpecialList/toString.html">toString</a></li>
<li class="inherited"><a href="fake/SpecialList/where.html">where</a></li>
</ol>
</div><!--/.sidebar-offcanvas-->
<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<section class="multi-line-signature">
<span class="returntype">void</span>
<span class="name ">setAll</span>(<wbr><span class="parameter" id="setAll-param-index"><span class="type-annotation">int</span> <span class="parameter-name">index</span></span>, <span class="parameter" id="setAll-param-iterable"><span class="type-annotation">Iterable<E></span> <span class="parameter-name">iterable</span></span>)
</section>
<section class="desc markdown">
<p>Overwrites objects of <code>this</code> with the objects of <code>iterable</code>, starting
at position <code>index</code> in this list.</p>
<pre class="prettyprint lang-dart"><code>List<String> list = ['a', 'b', 'c'];
list.setAll(1, ['bee', 'sea']);
list.join(', '); // 'a, bee, sea'
</code></pre>
<p>This operation does not increase the length of <code>this</code>.</p>
<p>The <code>index</code> must be non-negative and no greater than <code>length</code>.</p>
<p>The <code>iterable</code> must not have more elements than what can fit from <code>index</code>
to <code>length</code>.</p>
<p>If <code>iterable</code> is based on this list, its values may change /during/ the
<code>setAll</code> operation.</p>
</section>
</div> <!-- /.main-content -->
</div> <!-- row -->
</div> <!-- container -->
<footer>
<div class="container-fluid">
<div class="container">
<p class="text-center">
<span class="no-break">
test_package 0.0.1
</span>
•
<span class="no-break">
<a href="https://www.dartlang.org">
<img src="static-assets/favicon.png" alt="Dart" title="Dart" width="16" height="16">
</a>
</span>
•
<span class="copyright no-break">
<a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a>
</span>
</p>
</div>
</div>
</footer>
<script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
<script src="static-assets/typeahead.bundle.min.js"></script>
<script src="static-assets/prettify.js"></script>
<script src="static-assets/URI.js"></script>
<script src="static-assets/script.js"></script>
<!-- Do not remove placeholder -->
<!-- Footer Placeholder -->
</body>
</html>
|
<h1>Author name something***</h1>
<div data-sly-use.authorDetails="com.adobe.aem.guides.demo.core.models.Author"></div>
<div>Name: ${authorDetails.fullName}</div>
<div>Age: ${authorDetails.age}</div>
<div>Check Box: ${authorDetails.check}</div> |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>legacy-ring: Not compatible</title>
<link rel="shortcut icon" type="image/png" href="../../../../../favicon.png" />
<link href="../../../../../bootstrap.min.css" rel="stylesheet">
<link href="../../../../../bootstrap-custom.css" rel="stylesheet">
<link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
<script src="../../../../../moment.min.js"></script>
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container">
<div class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<a class="navbar-brand" href="../../../../.."><i class="fa fa-lg fa-flag-checkered"></i> Coq bench</a>
</div>
<div id="navbar" class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="../..">clean / released</a></li>
<li class="active"><a href="">8.7.0 / legacy-ring - 8.5.0</a></li>
</ul>
</div>
</div>
</div>
<div class="article">
<div class="row">
<div class="col-md-12">
<a href="../..">« Up</a>
<h1>
legacy-ring
<small>
8.5.0
<span class="label label-info">Not compatible</span>
</small>
</h1>
<p><em><script>document.write(moment("2021-09-23 20:14:32 +0000", "YYYY-MM-DD HH:mm:ss Z").fromNow());</script> (2021-09-23 20:14:32 UTC)</em><p>
<h2>Context</h2>
<pre># Packages matching: installed
# Name # Installed # Synopsis
base-bigarray base
base-threads base
base-unix base
camlp5 7.14 Preprocessor-pretty-printer of OCaml
conf-findutils 1 Virtual package relying on findutils
conf-perl 1 Virtual package relying on perl
coq 8.7.0 Formal proof management system
num 1.4 The legacy Num library for arbitrary-precision integer and rational arithmetic
ocaml 4.09.1 The OCaml compiler (virtual package)
ocaml-base-compiler 4.09.1 Official release 4.09.1
ocaml-config 1 OCaml Switch Configuration
ocamlfind 1.9.1 A library manager for OCaml
# opam file:
opam-version: "2.0"
maintainer: "matej.kosik@inria.fr"
homepage: "https://github.com/coq-contribs/legacy-ring"
license: "proprietary"
build: [make]
install: [make "install"]
remove: ["rm" "-R" "%{lib}%/coq/user-contrib/LegacyRing"]
depends: [
"ocaml"
"coq" {>= "8.5" & < "8.6~"}
]
authors: [ "Bruno Barras" "Benjamin Gregoire" ]
bug-reports: "https://github.com/coq-contribs/legacy-ring/issues"
dev-repo: "git+https://github.com/coq-contribs/legacy-ring.git"
synopsis: "The former implementation of the ring tactic"
flags: light-uninstall
url {
src: "https://github.com/coq-contribs/legacy-ring/archive/v8.5.0.tar.gz"
checksum: "md5=968200c2af235a5220fade33ff714b56"
}
</pre>
<h2>Lint</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
</dl>
<h2>Dry install</h2>
<p>Dry install with the current Coq version:</p>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>opam install -y --show-action coq-legacy-ring.8.5.0 coq.8.7.0</code></dd>
<dt>Return code</dt>
<dd>5120</dd>
<dt>Output</dt>
<dd><pre>[NOTE] Package coq is already installed (current version is 8.7.0).
The following dependencies couldn't be met:
- coq-legacy-ring -> coq < 8.6~ -> ocaml < 4.06.0
base of this switch (use `--unlock-base' to force)
No solution found, exiting
</pre></dd>
</dl>
<p>Dry install without Coq/switch base, to test if the problem was incompatibility with the current Coq/OCaml version:</p>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>opam remove -y coq; opam install -y --show-action --unlock-base coq-legacy-ring.8.5.0</code></dd>
<dt>Return code</dt>
<dd>0</dd>
</dl>
<h2>Install dependencies</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
<dt>Duration</dt>
<dd>0 s</dd>
</dl>
<h2>Install</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
<dt>Duration</dt>
<dd>0 s</dd>
</dl>
<h2>Installation size</h2>
<p>No files were installed.</p>
<h2>Uninstall</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
<dt>Missing removes</dt>
<dd>
none
</dd>
<dt>Wrong removes</dt>
<dd>
none
</dd>
</dl>
</div>
</div>
</div>
<hr/>
<div class="footer">
<p class="text-center">
<small>Sources are on <a href="https://github.com/coq-bench">GitHub</a>. © Guillaume Claret.</small>
</p>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script src="../../../../../bootstrap.min.js"></script>
</body>
</html>
|
<!DOCTYPE html>
<html>
<head>
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-MX8QJZ2');</script>
<!-- End Google Tag Manager -->
<title>Does Your Motherboard Matter for Gaming? (2020) </title>
<meta charset="utf-8" />
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<meta http-equiv='X-UA-Compatible' content='IE=edge'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1.0'>
<meta name="description" content="There are a lot of different motherboards on the market, bu does your motherboard matter for gaming?" />
<meta property="og:description" content="There are a lot of different motherboards on the market, bu does your motherboard matter for gaming?" />
<meta name="author" content="Easy PC" />
<meta property="og:title" content="Do You Need a Good Motherboard for Gaming in 2020?" />
<meta property="twitter:title" content="Do You Need a Good Motherboard for Gaming in 2020?" />
<div id="amzn-assoc-ad-7ee36eaa-b5b6-4047-aa06-ef63cf03c886"></div><script async src="//z-na.amazon-adsystem.com/widgets/onejs?MarketPlace=US&adInstanceId=7ee36eaa-b5b6-4047-aa06-ef63cf03c886"></script>
<!-- Facebook Pixel Code -->
<script>
!function(f,b,e,v,n,t,s)
{if(f.fbq)return;n=f.fbq=function(){n.callMethod?
n.callMethod.apply(n,arguments):n.queue.push(arguments)};
if(!f._fbq)f._fbq=n;n.push=n;n.loaded=!0;n.version='2.0';
n.queue=[];t=b.createElement(e);t.async=!0;
t.src=v;s=b.getElementsByTagName(e)[0];
s.parentNode.insertBefore(t,s)}(window, document,'script',
'https://connect.facebook.net/en_US/fbevents.js');
fbq('init', '1009421505904678');
fbq('track', 'PageView');
</script>
<noscript><img height="1" width="1" style="display:none"
src="https://www.facebook.com/tr?id=1009421505904678&ev=PageView&noscript=1"
/></noscript>
<!-- End Facebook Pixel Code -->
<!--[if lt IE 9]>
<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="/style.css" />
<link rel="alternate" type="application/rss+xml" title="Easy PC - " href="/feed.xml" />
<link href="https://fonts.googleapis.com/css?family=Lato:400,400i,700" rel="stylesheet">
<!-- Created with Jekyll Now - http://github.com/barryclark/jekyll-now -->
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
<link rel="manifest" href="/site.webmanifest">
<link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5">
<meta name="ahrefs-site-verification" content="3105cf5fdf3fd2569b94d4146fff097da3eebb619973f0e5d3f5e56799e22db4">
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<script src="https://unpkg.com/lazysizes@4.1.6/lazysizes.js" async></script>
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.8.2/css/all.css" integrity="sha384-oS3vJWv+0UjzBfQzYUhtDYW+Pj2yciDJxpsK1OYPAYjqT085Qq/1cq5FLXAZQ7Ay" crossorigin="anonymous">
<link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
</head>
<body>
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MX8QJZ2"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->
<div class="wrapper-masthead static">
<div class="container">
<header class="masthead clearfix">
<a href="/" class="site-avatar"><img src="/img/epc-logo.jpg" /></a>
<div class="site-info">
<h1 class="site-name"><a href="/">Easy PC</a></h1>
<p class="site-description"></p>
</div>
<nav>
<span class="item-with-sub">
<a href="/budget-pcs/">
<li>Budget Gaming PCs ▼</li>
<div class="sub-menu">
<a href="http://localhost:4000/budget-pcs/400/"><li>$400 Gaming PC</li></a>
<a href="http://localhost:4000/budget-pcs/500/"><li>$500 Gaming PC</li></a>
<a href="http://localhost:4000/budget-pcs/600/"><li>$600 Gaming PC</li></a>
<a href="http://localhost:4000/budget-pcs/700/"><li>$700 Gaming PC</li></a>
<a href="http://localhost:4000/budget-pcs/800/"><li>$800 Gaming PC</li></a>
<a href="http://localhost:4000/budget-pcs/900/"><li>$900 Gaming PC</li></a>
<a href="http://localhost:4000/budget-pcs/1000/"><li>$1000 Gaming PC</li></a>
</div>
</a>
</span>
<span class="item-with-sub">
<a href="/graphics-cards/">
<li>Graphics Cards ▼</li>
<div class="sub-menu">
<a href="http://localhost:4000/graphics-cards/gtx-1080-ti/"><li>GTX 1080 Ti</li></a>
</div>
</a>
</span>
<span class="item-with-sub">
<a href="/pc-cases/">
<li>Cases ▼</li>
<div class="sub-menu">
<a href="http://localhost:4000/pc-cases/cable-management/"><li>Cable Management Cases</li></a>
<a href="http://localhost:4000/pc-cases/hard-drive-storage/"><li>Hard Drive Storage Cases</li></a>
<a href="http://localhost:4000/pc-cases/hot-swappable/"><li>Hot Swappable Cases</li></a>
<a href="http://localhost:4000/pc-cases/nas/"><li>NAS Cases</li></a>
<a href="http://localhost:4000/pc-cases/smallest-atx-cases/"><li>Small ATX Cases</li></a>
<a href="http://localhost:4000/pc-cases/smallest-micro-atx-cases/"><li>Small Micro ATX Cases</li></a>
<a href="http://localhost:4000/pc-cases/inverted/"><li>Inverted PC Cases</li></a>
</div>
</a>
</span>
<a href="/DpiPpiCalculator">
<li>DPI / PPI Calculator</li>
</a>
</nav>
</header>
</div>
</div>
<div id="main" role="main" class="container">
<article class="page">
<h1>Do You Need a Good Motherboard for Gaming in 2020?</h1>
<div class="entry">
<div class="author-line">
<img class="author-image" alt="written by jacob tuwiner" src="/img/profile/close.jpg" />
<span>Jacob Tuwiner</span>
</div>
<ul id="markdown-toc">
<li><a href="#does-your-motherboard-affect-fps" id="markdown-toc-does-your-motherboard-affect-fps">Does Your Motherboard Affect FPS?</a>
</li>
<li><a href="#how-much-should-you-spend-on-a-gaming-motherboard" id="markdown-toc-how-much-should-you-spend-on-a-gaming-motherboard">How Much Should You Spend on a Gaming Motherboard?</a></li>
<li><a href="#things-to-look-for-in-a-motherboard-for-gaming" id="markdown-toc-things-to-look-for-in-a-motherboard-for-gaming">Things to Look for in a Motherboard (For Gaming)</a></li>
<li><a href="#verdict-do-you-need-a-good-motherboard-for-gaming" id="markdown-toc-verdict-do-you-need-a-good-motherboard-for-gaming">Verdict: Do You Need a Good Motherboard for Gaming?</a>
</li>
</ul>
<p>Asking the question “does your motherboard matter for gaming” is like asking if the type of wheels you have on your car affects your driving.</p>
<p>You won’t notice much of a difference in traction unless you spend a lot of money on tires.</p>
<p>Likewise, <strong>the type of motherboard you buy will not generally affect your gaming performance until you go to high-end models.</strong></p>
<h2 id="does-your-motherboard-affect-fps">Does Your Motherboard Affect FPS?</h2>
<p><a href="/motherboard/">Motherboards</a> do not directly influence your gaming performance at all.</p>
<p><img src="/img/motherboard-affect-fps/motherboard-pic.jpg" alt="picture of a motherboard" class="img-middle" /></p>
<p>What your motherboard type will do, is allow your graphics card and processor to perform better (or worse).</p>
<p>It’s sort of similar to a <a href="/will-ssd-improve-fps/">Solid State Drive’s impact on FPS</a>. It doesn’t directly affect framerate, but it definitely makes your PC more responsive overall and your games will load way faster as well.</p>
<h3 id="cpu">CPU</h3>
<p>On the processor side, it’s a lot more simple to explain.</p>
<p>The motherboard type will always have an effect on how far you can <a href="https://www.howtogeek.com/165064/what-is-overclocking-the-absolute-beginners-guide-to-understanding-how-geeks-speed-up-their-pcs/" target="_blank">overclock</a> your processor and still maintain stability.</p>
<p>Not all games will benefit noticeably from processor overclocking, but it never hurts to do it.</p>
<p>On Intel’s side, only Z-series motherboards allow for overclocking (but you also need a K-series CPU) and for the most part are top of the line in quality and feature set.</p>
<p>For AMD’s Ryzen platform, all of their chipsets besides the A320 budget chipset allow for overclocking with any Ryzen CPU.</p>
<p>Unlike Intel motherboards, however, these boards vary greatly in quality and capacity of overclocking</p>
<h3 id="gpu">GPU</h3>
<p>The gist of it is, <a href="https://store.hp.com/app/tech-takes/gpu-vs-cpu-for-pc-gaming" target="_blank">the GPU is the main contributor to your games’ FPS</a> so you want to have a quality conduit in the form of its PCIe port for it to read and transfer data.</p>
<p>PCIe x16 ports for graphics cards nowadays range from 2.0 (5GHz), to 3.0 (8GHz), to the new 4.0 designation motherboards brandishing double the bandwidth of 3.0 that is coming with the new Ryzen X570.</p>
<h2 id="how-much-should-you-spend-on-a-gaming-motherboard">How Much Should You Spend on a Gaming Motherboard?</h2>
<p>Most motherboards offer very little in the way of difference in gaming performance between them, so it may not always be justifiable to drop a couple of hundred dollars on your next board for an extra 4FPS.</p>
<p><img src="/img/mobo/msi-b350-pcmate.png" alt="msi b350 pcmate motherboard" class="img-right img-small" /></p>
<p>Our suggestion is to always go for mid-range boards if possible but, of course, some people are on a tight budget, and others wish to make a contest out of spending the most possible dough on their rig.</p>
<p>Bigger price doesn’t exactly mean bigger numbers when it comes to motherboards.</p>
<p>Price for motherboards is tied to a couple of things:</p>
<ul>
<li>Looks</li>
<li>Feature Set</li>
</ul>
<p>Higher end looking motherboards with all the fancy LED lights will always be priced higher due to those features, but they are often only paired with high-performance motherboards so maybe you’re in luck there.</p>
<p>The feature set will undoubtedly always boost the price of a motherboard as well. For example, a motherboard with three USB 3.0 ports will cost more than one with three USB 2.0 ports.</p>
<p>A lower end overclockable motherboard should only set you back around $75-$90 USD on AMD’s side depending on whether you go for B350 or B450, and for Intel, their Z370 and Z390 boards run you a little over $100USD for the lowest end models.</p>
<h2 id="things-to-look-for-in-a-motherboard-for-gaming">Things to Look for in a Motherboard (For Gaming)</h2>
<p>As we mentioned before, something you always need to look for in your new motherboard is its proficiency when overclocking, as this process gives your processor a major turbo boost in performance.</p>
<p><img src="/img/mobo/ab350m.jpg" alt="ab350 motherboard" class="img-middle" /></p>
<p>Chipsets often overclock at different levels. B450 motherboards will, more often than not, overclock much better than their B350 counterparts. And X370/470 motherboard is made for overclocking, so they will naturally outperform B350 and B450.</p>
<p>One very important thing to note when choosing an AMD motherboard is that the chipsets will not always be out-of-the-box compatible with every CPU configuration.</p>
<p>Each chipset was made for the processor generation they were released with, and while you can technically use any Ryzen CPU in any AM4 motherboard there are some holes to jump through.</p>
<p>To put it simply- Ryzen Gen 1 CPUs (1200, 1600, 1700) can run in any AM4 motherboard immediately.</p>
<p>Ryzen Gen 2 CPUs (2400G, 2600, 2700) can run in B450, X470, and X570 out of the box, but B350 and X370 boards will require an update to the latest BIOS version to be compatible (this process requires a compatible CPU).</p>
<p>The new 3000 series chips follow the pattern of the 2000s, except they are currently only out-of-the-box compatible with X570 boards.</p>
<p>As for Z370 and Z390 motherboards, though, there is literally no difference in overclocking capability between the two types.</p>
<p>We’ve actually explained the differences between Z370 and Z390 are explained in this article.</p>
<h2 id="verdict-do-you-need-a-good-motherboard-for-gaming">Verdict: Do You Need a Good Motherboard for Gaming?</h2>
<p>Your motherboard choice won’t ultimately affect your gaming experience too much.</p>
<p>Motherboard choice can, however, affect your overall PC experience.</p>
<h3 id="overclocking">Overclocking</h3>
<p>Overclocking is always going to be a prominent topic, so buckle your seatbelts and sit tight for another ride on the gains-train.</p>
<p>Overclocking just allows for too much of a performance boost, especially per dollar, to go ignored in any modern PC.</p>
<p>Increasing your overall CPU clock speed increases the general speed of your computer, contributing to much higher productivity and faster workload completion.</p>
<p>If you have the ability to do it, then do it! And if you have the choice to have the ability to do it… DO IT! Always overclock.</p>
<p>Your motherboard choice (specifically the chipset) will be important with regards to how far you can push the limits of your CPU.</p>
<p>So make sure you choose the right chipset for the right CPUs, you don’t need an X570 motherboard for a Ryzen 3 1200.</p>
<h3 id="longevity">Longevity</h3>
<p>The longevity of your motherboard is crucial to keeping your PC in perfect working condition for as long as possible, or at least until you upgrade.</p>
<p>Motherboards don’t tend to be the first thing to go in a rig, but that doesn’t mean that it isn’t still a possibility so always be prepared.</p>
<p>Make sure your board has ample warranty time and make sure to keep track of when your warranty ends.</p>
<h3 id="flair-if-youre-into-that-kind-of-thing">Flair (if you’re into that kind of thing)</h3>
<p>And most important of all… Get a board that you like the look of!</p>
<p>Not so important, we’ll be real with you, but hey it’s all about the aesthetic.</p>
<p>Even though sometimes it doesn’t matter at all since some people don’t even have side panel windows, (pathetic).</p>
<p>In all seriousness though, don’t buy a motherboard just because it looks cool.</p>
</div>
</article>
</div>
<div class="wrapper-footer">
<div class="container">
<footer class="footer">
<div class="footer-menu">
<a href="/contact/">Contact Us</a>
<a href="/about/">About Us</a>
<a href="/about/">Disclaimer</a>
</div>
<div class="icons">
<a href="https://www.twitter.com/easypcio"><i class="svg-icon twitter"></i></a>
<a href="https://youtube.com/easypcyoutubechannel"><i class="svg-icon youtube"></i></a>
</div>
</footer>
</div>
</div>
<!-- Google Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-102581591-1', 'auto');
ga('send', 'pageview', {
'page': '/motherboard/does-motherboard-matter-gaming/',
'title': 'Do You Need a Good Motherboard for Gaming in 2020?'
});
</script>
<!-- End Google Analytics -->
</body>
</html>
|
<!DOCTYPE html>
<html lang="en">
<head>
<base href="./" />
<meta charset="utf-8" />
<meta http-equiv="Content-Security-Policy" content="script-src 'self' 'unsafe-inline';" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<link rel="shortcut icon" href="./favicon.ico" />
<title>Aloe Blockchain</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<div id="root"></div>
<script>
global = globalThis;
</script>
</body>
</html> |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_292) on Tue Jul 06 23:55:43 SGT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Class com.hcl.domino.dxl.DxlImporter.XMLValidationOption (HCL Domino API 1.0.27-SNAPSHOT API)</title>
<meta name="date" content="2021-07-06">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Class com.hcl.domino.dxl.DxlImporter.XMLValidationOption (HCL Domino API 1.0.27-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../com/hcl/domino/dxl/DxlImporter.XMLValidationOption.html" title="enum in com.hcl.domino.dxl">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/hcl/domino/dxl/class-use/DxlImporter.XMLValidationOption.html" target="_top">Frames</a></li>
<li><a href="DxlImporter.XMLValidationOption.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class com.hcl.domino.dxl.DxlImporter.XMLValidationOption" class="title">Uses of Class<br>com.hcl.domino.dxl.DxlImporter.XMLValidationOption</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../com/hcl/domino/dxl/DxlImporter.XMLValidationOption.html" title="enum in com.hcl.domino.dxl">DxlImporter.XMLValidationOption</a></span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#com.hcl.domino.dxl">com.hcl.domino.dxl</a></td>
<td class="colLast"> </td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="com.hcl.domino.dxl">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../com/hcl/domino/dxl/DxlImporter.XMLValidationOption.html" title="enum in com.hcl.domino.dxl">DxlImporter.XMLValidationOption</a> in <a href="../../../../../com/hcl/domino/dxl/package-summary.html">com.hcl.domino.dxl</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../com/hcl/domino/dxl/package-summary.html">com.hcl.domino.dxl</a> that return <a href="../../../../../com/hcl/domino/dxl/DxlImporter.XMLValidationOption.html" title="enum in com.hcl.domino.dxl">DxlImporter.XMLValidationOption</a></span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../com/hcl/domino/dxl/DxlImporter.XMLValidationOption.html" title="enum in com.hcl.domino.dxl">DxlImporter.XMLValidationOption</a></code></td>
<td class="colLast"><span class="typeNameLabel">DxlImporter.</span><code><span class="memberNameLink"><a href="../../../../../com/hcl/domino/dxl/DxlImporter.html#getInputValidationOption--">getInputValidationOption</a></span>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../com/hcl/domino/dxl/DxlImporter.XMLValidationOption.html" title="enum in com.hcl.domino.dxl">DxlImporter.XMLValidationOption</a></code></td>
<td class="colLast"><span class="typeNameLabel">DxlImporter.XMLValidationOption.</span><code><span class="memberNameLink"><a href="../../../../../com/hcl/domino/dxl/DxlImporter.XMLValidationOption.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../com/hcl/domino/dxl/DxlImporter.XMLValidationOption.html" title="enum in com.hcl.domino.dxl">DxlImporter.XMLValidationOption</a>[]</code></td>
<td class="colLast"><span class="typeNameLabel">DxlImporter.XMLValidationOption.</span><code><span class="memberNameLink"><a href="../../../../../com/hcl/domino/dxl/DxlImporter.XMLValidationOption.html#values--">values</a></span>()</code>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../com/hcl/domino/dxl/package-summary.html">com.hcl.domino.dxl</a> with parameters of type <a href="../../../../../com/hcl/domino/dxl/DxlImporter.XMLValidationOption.html" title="enum in com.hcl.domino.dxl">DxlImporter.XMLValidationOption</a></span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><span class="typeNameLabel">DxlImporter.</span><code><span class="memberNameLink"><a href="../../../../../com/hcl/domino/dxl/DxlImporter.html#setInputValidationOption-com.hcl.domino.dxl.DxlImporter.XMLValidationOption-">setInputValidationOption</a></span>(<a href="../../../../../com/hcl/domino/dxl/DxlImporter.XMLValidationOption.html" title="enum in com.hcl.domino.dxl">DxlImporter.XMLValidationOption</a> option)</code> </td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../com/hcl/domino/dxl/DxlImporter.XMLValidationOption.html" title="enum in com.hcl.domino.dxl">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/hcl/domino/dxl/class-use/DxlImporter.XMLValidationOption.html" target="_top">Frames</a></li>
<li><a href="DxlImporter.XMLValidationOption.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2019–2021 <a href="http://www.hcl.com/">HCL</a>. All rights reserved.</small></p>
</body>
</html>
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RSGroupAdminEndpoint (Apache HBase 2.2.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RSGroupAdminEndpoint (Apache HBase 2.2.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RSGroupAdminEndpoint.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminClient.html" title="class in org.apache.hadoop.hbase.rsgroup"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.RSGroupAdminServiceImpl.html" title="class in org.apache.hadoop.hbase.rsgroup"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html" target="_top">Frames</a></li>
<li><a href="RSGroupAdminEndpoint.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hbase.rsgroup</div>
<h2 title="Class RSGroupAdminEndpoint" class="title">Class RSGroupAdminEndpoint</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.rsgroup.RSGroupAdminEndpoint</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessor</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterObserver</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Private
public class <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.95">RSGroupAdminEndpoint</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessor</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterObserver</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.RSGroupAdminServiceImpl.html" title="class in org.apache.hadoop.hbase.rsgroup">RSGroupAdminEndpoint.RSGroupAdminServiceImpl</a></span></code>
<div class="block">Implementation of RSGroupAdminService defined in RSGroupAdmin.proto.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.hbase.Coprocessor">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.<a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.State.html" title="enum in org.apache.hadoop.hbase">Coprocessor.State</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/security/access/AccessChecker.html" title="class in org.apache.hadoop.hbase.security.access">AccessChecker</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#accessChecker">accessChecker</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminServer.html" title="class in org.apache.hadoop.hbase.rsgroup">RSGroupAdminServer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#groupAdminServer">groupAdminServer</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private org.apache.hadoop.hbase.protobuf.generated.RSGroupAdminProtos.RSGroupAdminService</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#groupAdminService">groupAdminService</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupInfoManager.html" title="interface in org.apache.hadoop.hbase.rsgroup">RSGroupInfoManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#groupInfoManager">groupInfoManager</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#LOG">LOG</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/master/MasterServices.html" title="interface in org.apache.hadoop.hbase.master">MasterServices</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#master">master</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/security/UserProvider.html" title="class in org.apache.hadoop.hbase.security">UserProvider</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#userProvider">userProvider</a></span></code>
<div class="block">Provider for mapping principal names to Users</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.Coprocessor">
<!-- -->
</a>
<h3>Fields inherited from interface org.apache.hadoop.hbase.<a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#PRIORITY_HIGHEST">PRIORITY_HIGHEST</a>, <a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#PRIORITY_LOWEST">PRIORITY_LOWEST</a>, <a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#PRIORITY_SYSTEM">PRIORITY_SYSTEM</a>, <a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#PRIORITY_USER">PRIORITY_USER</a>, <a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#VERSION">VERSION</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#RSGroupAdminEndpoint--">RSGroupAdminEndpoint</a></span>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>(package private) void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#assignTableToGroup-org.apache.hadoop.hbase.client.TableDescriptor-">assignTableToGroup</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a> desc)</code> </td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#checkPermission-java.lang.String-">checkPermission</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> request)</code> </td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#getActiveUser--">getActiveUser</a></span>()</code>
<div class="block">Returns the active user to which authorization checks should be applied.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>(package private) <a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupInfoManager.html" title="interface in org.apache.hadoop.hbase.rsgroup">RSGroupInfoManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#getGroupInfoManager--">getGroupInfoManager</a></span>()</code> </td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterObserver</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#getMasterObserver--">getMasterObserver</a></span>()</code> </td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><com.google.protobuf.Service></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#getServices--">getServices</a></span>()</code>
<div class="block">Coprocessor endpoints providing protobuf services should override this method.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#postClearDeadServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-java.util.List-">postClearDeadServers</a></span>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>> servers,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>> notClearedServers)</code>
<div class="block">Called after clear dead region servers.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#postCreateTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.RegionInfo:A-">postCreateTable</a></span>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a> desc,
<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>[] regions)</code>
<div class="block">Called after the createTable operation has been requested.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#postDeleteTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">postDeleteTable</a></span>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code>
<div class="block">Called after the deleteTable operation has been requested.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#preCloneSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-org.apache.hadoop.hbase.client.TableDescriptor-">preCloneSnapshot</a></span>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="../../../../../org/apache/hadoop/hbase/client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client">SnapshotDescription</a> snapshot,
<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a> desc)</code>
<div class="block">Called before a snapshot is cloned.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#preCreateNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-">preCreateNamespace</a></span>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="../../../../../org/apache/hadoop/hbase/NamespaceDescriptor.html" title="class in org.apache.hadoop.hbase">NamespaceDescriptor</a> ns)</code>
<div class="block">Called before a new namespace is created by
<a href="../../../../../org/apache/hadoop/hbase/master/HMaster.html" title="class in org.apache.hadoop.hbase.master"><code>HMaster</code></a>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#preCreateTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.RegionInfo:A-">preCreateTableAction</a></span>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a> desc,
<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>[] regions)</code>
<div class="block">Called before a new table is created by
<a href="../../../../../org/apache/hadoop/hbase/master/HMaster.html" title="class in org.apache.hadoop.hbase.master"><code>HMaster</code></a>.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#preModifyNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-">preModifyNamespace</a></span>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="../../../../../org/apache/hadoop/hbase/NamespaceDescriptor.html" title="class in org.apache.hadoop.hbase">NamespaceDescriptor</a> ns)</code>
<div class="block">Called prior to modifying a namespace's properties.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>(package private) boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#rsgroupHasServersOnline-org.apache.hadoop.hbase.client.TableDescriptor-">rsgroupHasServersOnline</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a> desc)</code> </td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#start-org.apache.hadoop.hbase.CoprocessorEnvironment-">start</a></span>(<a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a> env)</code>
<div class="block">Called by the <a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> during it's own startup to initialize the
coprocessor.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#stop-org.apache.hadoop.hbase.CoprocessorEnvironment-">stop</a></span>(<a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a> env)</code>
<div class="block">Called by the <a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> during it's own shutdown to stop the
coprocessor.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.coprocessor.MasterObserver">
<!-- -->
</a>
<h3>Methods inherited from interface org.apache.hadoop.hbase.coprocessor.<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterObserver</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postAbortProcedure-org.apache.hadoop.hbase.coprocessor.ObserverContext-">postAbortProcedure</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postAddReplicationPeer-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.replication.ReplicationPeerConfig-">postAddReplicationPeer</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postAddRSGroup-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">postAddRSGroup</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postAssign-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo-">postAssign</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postBalance-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-">postBalance</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postBalanceRSGroup-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-boolean-">postBalanceRSGroup</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postBalanceSwitch-org.apache.hadoop.hbase.coprocessor.ObserverContext-boolean-boolean-">postBalanceSwitch</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCloneSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-org.apache.hadoop.hbase.client.TableDescriptor-">postCloneSnapshot</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCompletedCreateTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.RegionInfo:A-">postCompletedCreateTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCompletedDeleteTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">postCompletedDeleteTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCompletedDisableTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">postCompletedDisableTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCompletedEnableTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">postCompletedEnableTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCompletedMergeRegionsAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo:A-org.apache.hadoop.hbase.client.RegionInfo-">postCompletedMergeRegionsAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCompletedModifyTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.client.TableDescriptor-">postCompletedModifyTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCompletedModifyTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.TableDescriptor-">postCompletedModifyTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCompletedSplitRegionAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.hbase.client.RegionInfo-">postCompletedSplitRegionAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCompletedTruncateTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">postCompletedTruncateTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCreateNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-">postCreateNamespace</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postDecommissionRegionServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-boolean-">postDecommissionRegionServers</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postDeleteNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">postDeleteNamespace</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postDeleteSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-">postDeleteSnapshot</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postDisableReplicationPeer-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">postDisableReplicationPeer</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postDisableTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">postDisableTable</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postEnableReplicationPeer-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">postEnableReplicationPeer</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postEnableTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">postEnableTable</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postGetClusterMetrics-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.ClusterMetrics-">postGetClusterMetrics</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postGetLocks-org.apache.hadoop.hbase.coprocessor.ObserverContext-">postGetLocks</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postGetNamespaceDescriptor-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-">postGetNamespaceDescriptor</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postGetProcedures-org.apache.hadoop.hbase.coprocessor.ObserverContext-">postGetProcedures</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postGetReplicationPeerConfig-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">postGetReplicationPeerConfig</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postGetTableDescriptors-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-java.util.List-java.lang.String-">postGetTableDescriptors</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postGetTableNames-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-java.lang.String-">postGetTableNames</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postGetUserPermissions-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-java.lang.String-org.apache.hadoop.hbase.TableName-byte:A-byte:A-">postGetUserPermissions</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postGrant-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.security.access.UserPermission-boolean-">postGrant</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postHasUserPermissions-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-java.util.List-">postHasUserPermissions</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postIsRpcThrottleEnabled-org.apache.hadoop.hbase.coprocessor.ObserverContext-boolean-">postIsRpcThrottleEnabled</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postListDecommissionedRegionServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-">postListDecommissionedRegionServers</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postListNamespaceDescriptors-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-">postListNamespaceDescriptors</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postListReplicationPeers-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">postListReplicationPeers</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postListSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-">postListSnapshot</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postLockHeartbeat-org.apache.hadoop.hbase.coprocessor.ObserverContext-">postLockHeartbeat</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postMergeRegions-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo:A-">postMergeRegions</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postMergeRegionsCommitAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo:A-org.apache.hadoop.hbase.client.RegionInfo-">postMergeRegionsCommitAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postModifyNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-">postModifyNamespace</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postModifyNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-org.apache.hadoop.hbase.NamespaceDescriptor-">postModifyNamespace</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postModifyTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.client.TableDescriptor-">postModifyTable</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postModifyTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.TableDescriptor-">postModifyTable</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postMove-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.hbase.ServerName-org.apache.hadoop.hbase.ServerName-">postMove</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postMoveServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.Set-java.lang.String-">postMoveServers</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postMoveServersAndTables-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.Set-java.util.Set-java.lang.String-">postMoveServersAndTables</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postMoveTables-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.Set-java.lang.String-">postMoveTables</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postRecommissionRegionServer-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.ServerName-java.util.List-">postRecommissionRegionServer</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postRegionOffline-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo-">postRegionOffline</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postRemoveReplicationPeer-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">postRemoveReplicationPeer</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postRemoveRSGroup-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">postRemoveRSGroup</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postRemoveServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.Set-">postRemoveServers</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postRequestLock-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.client.RegionInfo:A-java.lang.String-">postRequestLock</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postRestoreSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-org.apache.hadoop.hbase.client.TableDescriptor-">postRestoreSnapshot</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postRevoke-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.security.access.UserPermission-">postRevoke</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postRollBackMergeRegionsAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo:A-">postRollBackMergeRegionsAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postRollBackSplitRegionAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-">postRollBackSplitRegionAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postSetNamespaceQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.quotas.GlobalQuotaSettings-">postSetNamespaceQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postSetRegionServerQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.quotas.GlobalQuotaSettings-">postSetRegionServerQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postSetSplitOrMergeEnabled-org.apache.hadoop.hbase.coprocessor.ObserverContext-boolean-org.apache.hadoop.hbase.client.MasterSwitchType-">postSetSplitOrMergeEnabled</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postSetTableQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.quotas.GlobalQuotaSettings-">postSetTableQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postSetUserQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.quotas.GlobalQuotaSettings-">postSetUserQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postSetUserQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-java.lang.String-org.apache.hadoop.hbase.quotas.GlobalQuotaSettings-">postSetUserQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postSetUserQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.quotas.GlobalQuotaSettings-">postSetUserQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-org.apache.hadoop.hbase.client.TableDescriptor-">postSnapshot</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postStartMaster-org.apache.hadoop.hbase.coprocessor.ObserverContext-">postStartMaster</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postSwitchExceedThrottleQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-boolean-boolean-">postSwitchExceedThrottleQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postSwitchRpcThrottle-org.apache.hadoop.hbase.coprocessor.ObserverContext-boolean-boolean-">postSwitchRpcThrottle</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postTableFlush-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">postTableFlush</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postTruncateTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">postTruncateTable</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postUnassign-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo-boolean-">postUnassign</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postUpdateReplicationPeerConfig-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.replication.ReplicationPeerConfig-">postUpdateReplicationPeerConfig</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preAbortProcedure-org.apache.hadoop.hbase.coprocessor.ObserverContext-long-">preAbortProcedure</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preAddReplicationPeer-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.replication.ReplicationPeerConfig-">preAddReplicationPeer</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preAddRSGroup-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">preAddRSGroup</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preAssign-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo-">preAssign</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preBalance-org.apache.hadoop.hbase.coprocessor.ObserverContext-">preBalance</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preBalanceRSGroup-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">preBalanceRSGroup</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preBalanceSwitch-org.apache.hadoop.hbase.coprocessor.ObserverContext-boolean-">preBalanceSwitch</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preClearDeadServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-">preClearDeadServers</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preCreateTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.RegionInfo:A-">preCreateTable</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preCreateTableRegionsInfos-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.TableDescriptor-">preCreateTableRegionsInfos</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preDecommissionRegionServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-boolean-">preDecommissionRegionServers</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preDeleteNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">preDeleteNamespace</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preDeleteSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-">preDeleteSnapshot</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preDeleteTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">preDeleteTable</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preDeleteTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">preDeleteTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preDisableReplicationPeer-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">preDisableReplicationPeer</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preDisableTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">preDisableTable</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preDisableTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">preDisableTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preEnableReplicationPeer-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">preEnableReplicationPeer</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preEnableTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">preEnableTable</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preEnableTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">preEnableTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preGetClusterMetrics-org.apache.hadoop.hbase.coprocessor.ObserverContext-">preGetClusterMetrics</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preGetLocks-org.apache.hadoop.hbase.coprocessor.ObserverContext-">preGetLocks</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preGetNamespaceDescriptor-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">preGetNamespaceDescriptor</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preGetProcedures-org.apache.hadoop.hbase.coprocessor.ObserverContext-">preGetProcedures</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preGetReplicationPeerConfig-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">preGetReplicationPeerConfig</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preGetTableDescriptors-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-java.util.List-java.lang.String-">preGetTableDescriptors</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preGetTableNames-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-java.lang.String-">preGetTableNames</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preGetUserPermissions-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-java.lang.String-org.apache.hadoop.hbase.TableName-byte:A-byte:A-">preGetUserPermissions</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preGrant-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.security.access.UserPermission-boolean-">preGrant</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preHasUserPermissions-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-java.util.List-">preHasUserPermissions</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preIsRpcThrottleEnabled-org.apache.hadoop.hbase.coprocessor.ObserverContext-">preIsRpcThrottleEnabled</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preListDecommissionedRegionServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-">preListDecommissionedRegionServers</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preListNamespaceDescriptors-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-">preListNamespaceDescriptors</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preListReplicationPeers-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">preListReplicationPeers</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preListSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-">preListSnapshot</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preLockHeartbeat-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-java.lang.String-">preLockHeartbeat</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preMasterInitialization-org.apache.hadoop.hbase.coprocessor.ObserverContext-">preMasterInitialization</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preMergeRegions-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo:A-">preMergeRegions</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preMergeRegionsAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo:A-">preMergeRegionsAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preMergeRegionsCommitAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo:A-java.util.List-">preMergeRegionsCommitAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preModifyNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-org.apache.hadoop.hbase.NamespaceDescriptor-">preModifyNamespace</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preModifyTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.client.TableDescriptor-">preModifyTable</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preModifyTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.TableDescriptor-">preModifyTable</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preModifyTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.client.TableDescriptor-">preModifyTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preModifyTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.TableDescriptor-">preModifyTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preMove-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.hbase.ServerName-org.apache.hadoop.hbase.ServerName-">preMove</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preMoveServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.Set-java.lang.String-">preMoveServers</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preMoveServersAndTables-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.Set-java.util.Set-java.lang.String-">preMoveServersAndTables</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preMoveTables-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.Set-java.lang.String-">preMoveTables</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preRecommissionRegionServer-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.ServerName-java.util.List-">preRecommissionRegionServer</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preRegionOffline-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo-">preRegionOffline</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preRemoveReplicationPeer-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">preRemoveReplicationPeer</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preRemoveRSGroup-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-">preRemoveRSGroup</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preRemoveServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.Set-">preRemoveServers</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preRequestLock-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.client.RegionInfo:A-java.lang.String-">preRequestLock</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preRestoreSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-org.apache.hadoop.hbase.client.TableDescriptor-">preRestoreSnapshot</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preRevoke-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.security.access.UserPermission-">preRevoke</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSetNamespaceQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.quotas.GlobalQuotaSettings-">preSetNamespaceQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSetRegionServerQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.quotas.GlobalQuotaSettings-">preSetRegionServerQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSetSplitOrMergeEnabled-org.apache.hadoop.hbase.coprocessor.ObserverContext-boolean-org.apache.hadoop.hbase.client.MasterSwitchType-">preSetSplitOrMergeEnabled</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSetTableQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.quotas.GlobalQuotaSettings-">preSetTableQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSetUserQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.quotas.GlobalQuotaSettings-">preSetUserQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSetUserQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-java.lang.String-org.apache.hadoop.hbase.quotas.GlobalQuotaSettings-">preSetUserQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSetUserQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.quotas.GlobalQuotaSettings-">preSetUserQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preShutdown-org.apache.hadoop.hbase.coprocessor.ObserverContext-">preShutdown</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-org.apache.hadoop.hbase.client.TableDescriptor-">preSnapshot</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSplitRegion-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-byte:A-">preSplitRegion</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSplitRegionAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-byte:A-">preSplitRegionAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSplitRegionAfterMETAAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-">preSplitRegionAfterMETAAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSplitRegionBeforeMETAAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-byte:A-java.util.List-">preSplitRegionBeforeMETAAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preStopMaster-org.apache.hadoop.hbase.coprocessor.ObserverContext-">preStopMaster</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSwitchExceedThrottleQuota-org.apache.hadoop.hbase.coprocessor.ObserverContext-boolean-">preSwitchExceedThrottleQuota</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preSwitchRpcThrottle-org.apache.hadoop.hbase.coprocessor.ObserverContext-boolean-">preSwitchRpcThrottle</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preTableFlush-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">preTableFlush</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preTruncateTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">preTruncateTable</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preTruncateTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">preTruncateTableAction</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preUnassign-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.RegionInfo-boolean-">preUnassign</a>, <a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preUpdateReplicationPeerConfig-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.lang.String-org.apache.hadoop.hbase.replication.ReplicationPeerConfig-">preUpdateReplicationPeerConfig</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="LOG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOG</h4>
<pre>private static final org.slf4j.Logger <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.96">LOG</a></pre>
</li>
</ul>
<a name="master">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>master</h4>
<pre>private <a href="../../../../../org/apache/hadoop/hbase/master/MasterServices.html" title="interface in org.apache.hadoop.hbase.master">MasterServices</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.98">master</a></pre>
</li>
</ul>
<a name="groupInfoManager">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupInfoManager</h4>
<pre>private <a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupInfoManager.html" title="interface in org.apache.hadoop.hbase.rsgroup">RSGroupInfoManager</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.101">groupInfoManager</a></pre>
</li>
</ul>
<a name="groupAdminServer">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupAdminServer</h4>
<pre>private <a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminServer.html" title="class in org.apache.hadoop.hbase.rsgroup">RSGroupAdminServer</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.102">groupAdminServer</a></pre>
</li>
</ul>
<a name="groupAdminService">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupAdminService</h4>
<pre>private final org.apache.hadoop.hbase.protobuf.generated.RSGroupAdminProtos.RSGroupAdminService <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.103">groupAdminService</a></pre>
</li>
</ul>
<a name="accessChecker">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accessChecker</h4>
<pre>private <a href="../../../../../org/apache/hadoop/hbase/security/access/AccessChecker.html" title="class in org.apache.hadoop.hbase.security.access">AccessChecker</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.104">accessChecker</a></pre>
</li>
</ul>
<a name="userProvider">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>userProvider</h4>
<pre>private <a href="../../../../../org/apache/hadoop/hbase/security/UserProvider.html" title="class in org.apache.hadoop.hbase.security">UserProvider</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.107">userProvider</a></pre>
<div class="block">Provider for mapping principal names to Users</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RSGroupAdminEndpoint--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RSGroupAdminEndpoint</h4>
<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.95">RSGroupAdminEndpoint</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="start-org.apache.hadoop.hbase.CoprocessorEnvironment-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.110">start</a>(<a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a> env)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#start-org.apache.hadoop.hbase.CoprocessorEnvironment-">Coprocessor</a></code></span></div>
<div class="block">Called by the <a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> during it's own startup to initialize the
coprocessor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#start-org.apache.hadoop.hbase.CoprocessorEnvironment-">start</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="stop-org.apache.hadoop.hbase.CoprocessorEnvironment-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.131">stop</a>(<a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a> env)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#stop-org.apache.hadoop.hbase.CoprocessorEnvironment-">Coprocessor</a></code></span></div>
<div class="block">Called by the <a href="../../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> during it's own shutdown to stop the
coprocessor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#stop-org.apache.hadoop.hbase.CoprocessorEnvironment-">stop</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code></dd>
</dl>
</li>
</ul>
<a name="getServices--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServices</h4>
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><com.google.protobuf.Service> <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.136">getServices</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#getServices--">Coprocessor</a></code></span></div>
<div class="block">Coprocessor endpoints providing protobuf services should override this method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html#getServices--">getServices</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Iterable of <code>Service</code>s or empty collection. Implementations should never
return null.</dd>
</dl>
</li>
</ul>
<a name="getMasterObserver--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMasterObserver</h4>
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterObserver</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.141">getMasterObserver</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessor.html#getMasterObserver--">getMasterObserver</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessor</a></code></dd>
</dl>
</li>
</ul>
<a name="getGroupInfoManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupInfoManager</h4>
<pre><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupInfoManager.html" title="interface in org.apache.hadoop.hbase.rsgroup">RSGroupInfoManager</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.145">getGroupInfoManager</a>()</pre>
</li>
</ul>
<a name="rsgroupHasServersOnline-org.apache.hadoop.hbase.client.TableDescriptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rsgroupHasServersOnline</h4>
<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.404">rsgroupHasServersOnline</a>(<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a> desc)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="assignTableToGroup-org.apache.hadoop.hbase.client.TableDescriptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assignTableToGroup</h4>
<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.433">assignTableToGroup</a>(<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a> desc)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="preCreateTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.RegionInfo:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preCreateTableAction</h4>
<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.456">preCreateTableAction</a>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a> desc,
<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>[] regions)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preCreateTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.RegionInfo:A-">MasterObserver</a></code></span></div>
<div class="block">Called before a new table is created by
<a href="../../../../../org/apache/hadoop/hbase/master/HMaster.html" title="class in org.apache.hadoop.hbase.master"><code>HMaster</code></a>. Called as part of create
table procedure and it is async to the create RPC call.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preCreateTableAction-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.RegionInfo:A-">preCreateTableAction</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterObserver</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ctx</code> - the environment to interact with the framework and master</dd>
<dd><code>desc</code> - the TableDescriptor for the table</dd>
<dd><code>regions</code> - the initial regions created for the table</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="postCreateTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.RegionInfo:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>postCreateTable</h4>
<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.468">postCreateTable</a>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a> desc,
<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>[] regions)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCreateTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.RegionInfo:A-">MasterObserver</a></code></span></div>
<div class="block">Called after the createTable operation has been requested. Called as part
of create table RPC call.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postCreateTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.TableDescriptor-org.apache.hadoop.hbase.client.RegionInfo:A-">postCreateTable</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterObserver</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ctx</code> - the environment to interact with the framework and master</dd>
<dd><code>desc</code> - the TableDescriptor for the table</dd>
<dd><code>regions</code> - the initial regions created for the table</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="postDeleteTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>postDeleteTable</h4>
<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.475">postDeleteTable</a>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postDeleteTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">MasterObserver</a></code></span></div>
<div class="block">Called after the deleteTable operation has been requested. Called as part
of delete table RPC call.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postDeleteTable-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.TableName-">postDeleteTable</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterObserver</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ctx</code> - the environment to interact with the framework and master</dd>
<dd><code>tableName</code> - the name of the table</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="preCreateNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preCreateNamespace</h4>
<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.490">preCreateNamespace</a>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="../../../../../org/apache/hadoop/hbase/NamespaceDescriptor.html" title="class in org.apache.hadoop.hbase">NamespaceDescriptor</a> ns)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preCreateNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-">MasterObserver</a></code></span></div>
<div class="block">Called before a new namespace is created by
<a href="../../../../../org/apache/hadoop/hbase/master/HMaster.html" title="class in org.apache.hadoop.hbase.master"><code>HMaster</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preCreateNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-">preCreateNamespace</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterObserver</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ctx</code> - the environment to interact with the framework and master</dd>
<dd><code>ns</code> - the NamespaceDescriptor for the table</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="preModifyNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preModifyNamespace</h4>
<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.499">preModifyNamespace</a>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="../../../../../org/apache/hadoop/hbase/NamespaceDescriptor.html" title="class in org.apache.hadoop.hbase">NamespaceDescriptor</a> ns)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preModifyNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-">MasterObserver</a></code></span></div>
<div class="block">Called prior to modifying a namespace's properties.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preModifyNamespace-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.NamespaceDescriptor-">preModifyNamespace</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterObserver</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ctx</code> - the environment to interact with the framework and master</dd>
<dd><code>ns</code> - after modify operation, namespace will have this descriptor</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="preCloneSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-org.apache.hadoop.hbase.client.TableDescriptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preCloneSnapshot</h4>
<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.505">preCloneSnapshot</a>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="../../../../../org/apache/hadoop/hbase/client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client">SnapshotDescription</a> snapshot,
<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a> desc)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preCloneSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-org.apache.hadoop.hbase.client.TableDescriptor-">MasterObserver</a></code></span></div>
<div class="block">Called before a snapshot is cloned.
Called as part of restoreSnapshot RPC call.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#preCloneSnapshot-org.apache.hadoop.hbase.coprocessor.ObserverContext-org.apache.hadoop.hbase.client.SnapshotDescription-org.apache.hadoop.hbase.client.TableDescriptor-">preCloneSnapshot</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterObserver</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ctx</code> - the environment to interact with the framework and master</dd>
<dd><code>snapshot</code> - the SnapshotDescriptor for the snapshot</dd>
<dd><code>desc</code> - the TableDescriptor of the table to create</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="postClearDeadServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>postClearDeadServers</h4>
<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.511">postClearDeadServers</a>(<a href="../../../../../org/apache/hadoop/hbase/coprocessor/ObserverContext.html" title="interface in org.apache.hadoop.hbase.coprocessor">ObserverContext</a><<a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterCoprocessorEnvironment</a>> ctx,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>> servers,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>> notClearedServers)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postClearDeadServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-java.util.List-">MasterObserver</a></code></span></div>
<div class="block">Called after clear dead region servers.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html#postClearDeadServers-org.apache.hadoop.hbase.coprocessor.ObserverContext-java.util.List-java.util.List-">postClearDeadServers</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/coprocessor/MasterObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">MasterObserver</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="checkPermission-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkPermission</h4>
<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.523">checkPermission</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> request)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getActiveUser--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getActiveUser</h4>
<pre>private <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#line.532">getActiveUser</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Returns the active user to which authorization checks should be applied.
If we are in the context of an RPC call, the remote user is used,
otherwise the currently logged in user is used.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RSGroupAdminEndpoint.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminClient.html" title="class in org.apache.hadoop.hbase.rsgroup"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.RSGroupAdminServiceImpl.html" title="class in org.apache.hadoop.hbase.rsgroup"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html" target="_top">Frames</a></li>
<li><a href="RSGroupAdminEndpoint.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>idxassoc: Not compatible</title>
<link rel="shortcut icon" type="image/png" href="../../../../../favicon.png" />
<link href="../../../../../bootstrap.min.css" rel="stylesheet">
<link href="../../../../../bootstrap-custom.css" rel="stylesheet">
<link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
<script src="../../../../../moment.min.js"></script>
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container">
<div class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<a class="navbar-brand" href="../../../../.."><i class="fa fa-lg fa-flag-checkered"></i> Coq bench</a>
</div>
<div id="navbar" class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="../..">clean / released</a></li>
<li class="active"><a href="">8.11.2 / idxassoc - 8.7.0</a></li>
</ul>
</div>
</div>
</div>
<div class="article">
<div class="row">
<div class="col-md-12">
<a href="../..">« Up</a>
<h1>
idxassoc
<small>
8.7.0
<span class="label label-info">Not compatible</span>
</small>
</h1>
<p><em><script>document.write(moment("2021-04-14 05:24:55 +0000", "YYYY-MM-DD HH:mm:ss Z").fromNow());</script> (2021-04-14 05:24:55 UTC)</em><p>
<h2>Context</h2>
<pre># Packages matching: installed
# Name # Installed # Synopsis
base-bigarray base
base-threads base
base-unix base
conf-findutils 1 Virtual package relying on findutils
coq 8.11.2 Formal proof management system
num 1.4 The legacy Num library for arbitrary-precision integer and rational arithmetic
ocaml 4.11.1 The OCaml compiler (virtual package)
ocaml-base-compiler 4.11.1 Official release 4.11.1
ocaml-config 1 OCaml Switch Configuration
ocamlfind 1.9.1 A library manager for OCaml
# opam file:
opam-version: "2.0"
maintainer: "Hugo.Herbelin@inria.fr"
homepage: "https://github.com/coq-contribs/idxassoc"
license: "BSD with advertising clause"
build: [make "-j%{jobs}%"]
install: [make "install"]
remove: ["rm" "-R" "%{lib}%/coq/user-contrib/IdxAssoc"]
depends: [
"ocaml"
"coq" {>= "8.7" & < "8.8~"}
]
tags: [ "keyword: associative arrays" "keyword: search operator" "keyword: data structures" "category: Computer Science/Data Types and Data Structures" "date: April 2001" ]
authors: [ "Dominique Quatravaux" "François-René Ridaux" "Gérald Macinenti" ]
bug-reports: "https://github.com/coq-contribs/idxassoc/issues"
dev-repo: "git+https://github.com/coq-contribs/idxassoc.git"
synopsis: "Associative Arrays"
description: """
We define the associative array (key -> value associations)
datatype as list of couples, providing definitions of standards
operations such as adding, deleting.
We introduce predicates for membership of a key and of couples.
Finally we define a search operator ("find") which returns the
value associated with a key or the "none" option (see file
Option.v which should be part of this contribution) on failure.
Lemmas we prove about these concepts were motivated by our needs
at the moment we created this file. We hope they'll suit your
needs too but anyway, feel free to communicate any wish or
remark."""
flags: light-uninstall
url {
src: "https://github.com/coq-contribs/idxassoc/archive/v8.7.0.tar.gz"
checksum: "md5=35a56997f739b213f679dd1566fe3072"
}
</pre>
<h2>Lint</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
</dl>
<h2>Dry install</h2>
<p>Dry install with the current Coq version:</p>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>opam install -y --show-action coq-idxassoc.8.7.0 coq.8.11.2</code></dd>
<dt>Return code</dt>
<dd>5120</dd>
<dt>Output</dt>
<dd><pre>[NOTE] Package coq is already installed (current version is 8.11.2).
The following dependencies couldn't be met:
- coq-idxassoc -> coq < 8.8~ -> ocaml < 4.10
base of this switch (use `--unlock-base' to force)
No solution found, exiting
</pre></dd>
</dl>
<p>Dry install without Coq/switch base, to test if the problem was incompatibility with the current Coq/OCaml version:</p>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>opam remove -y coq; opam install -y --show-action --unlock-base coq-idxassoc.8.7.0</code></dd>
<dt>Return code</dt>
<dd>0</dd>
</dl>
<h2>Install dependencies</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
<dt>Duration</dt>
<dd>0 s</dd>
</dl>
<h2>Install</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
<dt>Duration</dt>
<dd>0 s</dd>
</dl>
<h2>Installation size</h2>
<p>No files were installed.</p>
<h2>Uninstall</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
<dt>Missing removes</dt>
<dd>
none
</dd>
<dt>Wrong removes</dt>
<dd>
none
</dd>
</dl>
</div>
</div>
</div>
<hr/>
<div class="footer">
<p class="text-center">
<small>Sources are on <a href="https://github.com/coq-bench">GitHub</a>. © Guillaume Claret.</small>
</p>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script src="../../../../../bootstrap.min.js"></script>
</body>
</html>
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../../../../">
<title data-ice="title">src/components/tabs/Tabs.form.js | formiojs</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
<meta name="description" content="Common js library for client side interaction with <form.io>"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="formiojs"><meta property="twitter:description" content="Common js library for client side interaction with <form.io>"></head>
<body class="layout-container" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
<a style="position:relative; top:3px;" href="https://github.com/olivbd/formio.js"><img width="20px" src="./image/github.png"></a></header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/EventEmitter.js~EventEmitter.html">EventEmitter</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Form.js~Form.html">Form</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/FormBuilder.js~FormBuilder.html">FormBuilder</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Formio.js~Formio.html">Formio</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/PDF.js~PDF.html">PDF</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/PDFBuilder.js~PDFBuilder.html">PDFBuilder</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Webform.js~Webform.html">Webform</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/WebformBuilder.js~WebformBuilder.html">WebformBuilder</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Wizard.js~Wizard.html">Wizard</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/WizardBuilder.js~WizardBuilder.html">WizardBuilder</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components">components</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/Components.js~Components.html">Components</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-address">components/address</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/address/Address.js~AddressComponent.html">AddressComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Address">Address</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-base">components/base</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/base/Base.js~BaseComponent.html">BaseComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Base">Base</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-base-editform">components/base/editForm</a><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-EditFormUtils">EditFormUtils</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-button">components/button</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/button/Button.js~ButtonComponent.html">ButtonComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Button">Button</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-checkbox">components/checkbox</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/checkbox/Checkbox.js~CheckBoxComponent.html">CheckBoxComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Checkbox">Checkbox</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-columns">components/columns</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/columns/Column.js~ColumnComponent.html">ColumnComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/columns/Columns.js~ColumnsComponent.html">ColumnsComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Columns">Columns</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-container">components/container</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/container/Container.js~ContainerComponent.html">ContainerComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Container">Container</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-content">components/content</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/content/Content.js~ContentComponent.html">ContentComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Content">Content</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-currency">components/currency</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/currency/Currency.js~CurrencyComponent.html">CurrencyComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Currency">Currency</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-datagrid">components/datagrid</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/datagrid/DataGrid.js~DataGridComponent.html">DataGridComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-DataGrid">DataGrid</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-datamap">components/datamap</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/datamap/DataMap.js~DataMapComponent.html">DataMapComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-DataMap">DataMap</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-datetime">components/datetime</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/datetime/DateTime.js~DateTimeComponent.html">DateTimeComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-DateTime">DateTime</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-day">components/day</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/day/Day.js~DayComponent.html">DayComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Day">Day</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-editgrid">components/editgrid</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/editgrid/EditGrid.js~EditGridComponent.html">EditGridComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-EditGrid">EditGrid</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-edittable">components/edittable</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/edittable/EditTable.js~EditTableComponent.html">EditTableComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-EditTable">EditTable</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-email">components/email</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/email/Email.js~EmailComponent.html">EmailComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Email">Email</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-fieldset">components/fieldset</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/fieldset/Fieldset.js~FieldsetComponent.html">FieldsetComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Fieldset">Fieldset</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-file">components/file</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/file/File.js~FileComponent.html">FileComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-File">File</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-form">components/form</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/form/Form.js~FormComponent.html">FormComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Form">Form</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-hidden">components/hidden</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/hidden/Hidden.js~HiddenComponent.html">HiddenComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Hidden">Hidden</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-html">components/html</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/html/HTML.js~HTMLComponent.html">HTMLComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-HTML">HTML</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-location">components/location</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/location/Location.js~LocationComponent.html">LocationComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Location">Location</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-modaledit">components/modaledit</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/modaledit/ModalEdit.js~ModalEditComponent.html">ModalEditComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-ModalEdit">ModalEdit</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-nested">components/nested</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/nested/NestedComponent.js~NestedComponent.html">NestedComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-NestedComponent">NestedComponent</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-number">components/number</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/number/Number.js~NumberComponent.html">NumberComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Number">Number</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-panel">components/panel</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/panel/Panel.js~PanelComponent.html">PanelComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Panel">Panel</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-password">components/password</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/password/Password.js~PasswordComponent.html">PasswordComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Password">Password</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-phonenumber">components/phonenumber</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/phonenumber/PhoneNumber.js~PhoneNumberComponent.html">PhoneNumberComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-PhoneNumber">PhoneNumber</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-radio">components/radio</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/radio/Radio.js~RadioComponent.html">RadioComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Radio">Radio</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-recaptcha">components/recaptcha</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/recaptcha/ReCaptcha.js~ReCaptchaComponent.html">ReCaptchaComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-ReCaptcha">ReCaptcha</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-resource">components/resource</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/resource/Resource.js~ResourceComponent.html">ResourceComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Resource">Resource</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-select">components/select</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/select/Select.js~SelectComponent.html">SelectComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Select">Select</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-selectboxes">components/selectboxes</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/selectboxes/SelectBoxes.js~SelectBoxesComponent.html">SelectBoxesComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-SelectBoxes">SelectBoxes</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-signature">components/signature</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/signature/Signature.js~SignatureComponent.html">SignatureComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Signature">Signature</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-survey">components/survey</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/survey/Survey.js~SurveyComponent.html">SurveyComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Survey">Survey</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-table">components/table</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/table/Table.js~TableComponent.html">TableComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Table">Table</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-tabs">components/tabs</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/tabs/Tabs.js~TabsComponent.html">TabsComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Tabs">Tabs</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-tags">components/tags</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/tags/Tags.js~TagsComponent.html">TagsComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Tags">Tags</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-textarea">components/textarea</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/textarea/TextArea.js~TextAreaComponent.html">TextAreaComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-TextArea">TextArea</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-textfield">components/textfield</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/textfield/TextField.js~TextFieldComponent.html">TextFieldComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-TextField">TextField</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-time">components/time</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/time/Time.js~TimeComponent.html">TimeComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Time">Time</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-tree">components/tree</a><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Tree">Tree</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-unknown">components/unknown</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/unknown/Unknown.js~UnknownComponent.html">UnknownComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Unknown">Unknown</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-url">components/url</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/url/Url.js~UrlComponent.html">UrlComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Url">Url</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components-well">components/well</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/components/well/Well.js~WellComponent.html">WellComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Well">Well</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#contrib">contrib</a><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-Contrib">Contrib</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#contrib-sketchpad">contrib/sketchpad</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/contrib/sketchpad/sketchpad.js~Sketchpad.html">Sketchpad</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Sketchpad">Sketchpad</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#contrib-stripe-checkout">contrib/stripe/checkout</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/contrib/stripe/checkout/StripeCheckout.js~StripeCheckoutComponent.html">StripeCheckoutComponent</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#contrib-stripe-stripe">contrib/stripe/stripe</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/contrib/stripe/stripe/Stripe.js~StripeComponent.html">StripeComponent</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#contrib-tagpad">contrib/tagpad</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/contrib/tagpad/tagpad.js~Tagpad.html">Tagpad</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Tagpad">Tagpad</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#providers-storage">providers/storage</a><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-azure">azure</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-base64">base64</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-dropbox">dropbox</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-s3">s3</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-url">url</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-XHR">XHR</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#utils">utils</a><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-applyFormChanges">applyFormChanges</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-eachComponent">eachComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-escapeRegExCharacters">escapeRegExCharacters</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-findComponent">findComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-findComponents">findComponents</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-flattenComponents">flattenComponents</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-formatAsCurrency">formatAsCurrency</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-generateFormChange">generateFormChange</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getComponent">getComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getStrings">getStrings</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getValue">getValue</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-hasCondition">hasCondition</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-isLayoutComponent">isLayoutComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-matchComponent">matchComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-parseFloatExt">parseFloatExt</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-removeComponent">removeComponent</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-searchComponents">searchComponents</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-addTemplateHash">addTemplateHash</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-boolValue">boolValue</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-bootstrapVersion">bootstrapVersion</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-checkCalculated">checkCalculated</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-checkCondition">checkCondition</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-checkCustomConditional">checkCustomConditional</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-checkJsonConditional">checkJsonConditional</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-checkSimpleConditional">checkSimpleConditional</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-checkTrigger">checkTrigger</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-convertFormatToFlatpickr">convertFormatToFlatpickr</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-convertFormatToMask">convertFormatToMask</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-convertFormatToMoment">convertFormatToMoment</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-currentTimezone">currentTimezone</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-delay">delay</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-evaluate">evaluate</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-fieldData">fieldData</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-formatDate">formatDate</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-formatOffset">formatOffset</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getCurrencyAffixes">getCurrencyAffixes</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getDateSetting">getDateSetting</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getElementRect">getElementRect</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getInputMask">getInputMask</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getLocaleDateFormatInfo">getLocaleDateFormatInfo</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getNumberDecimalLimit">getNumberDecimalLimit</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getNumberSeparators">getNumberSeparators</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getPropertyValue">getPropertyValue</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getRandomComponentId">getRandomComponentId</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-guid">guid</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-interpolate">interpolate</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-isMongoId">isMongoId</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-isValidDate">isValidDate</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-iterateKey">iterateKey</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-loadZones">loadZones</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-matchInputMask">matchInputMask</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-momentDate">momentDate</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-observeOverload">observeOverload</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-offsetDate">offsetDate</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-setActionProperty">setActionProperty</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-shouldLoadZones">shouldLoadZones</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-unfold">unfold</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-uniqueKey">uniqueKey</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-uniqueName">uniqueName</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-withSwitch">withSwitch</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-zonesLoaded">zonesLoaded</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-firstNonNil">firstNonNil</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#utils-jsonlogic">utils/jsonlogic</a><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-lodashOperators">lodashOperators</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#widgets">widgets</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/widgets/CalendarWidget.js~CalendarWidget.html">CalendarWidget</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/widgets/InputWidget.js~InputWidget.html">InputWidget</a></span></span></li>
</ul>
</div>
</nav>
<div class="content" data-ice="content"><h1 data-ice="title">src/components/tabs/Tabs.form.js</h1>
<pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">import nestedComponentForm from '../nested/NestedComponent.form';
import TabsEditDisplay from './editForm/Tabs.edit.display';
export default function(...extend) {
return nestedComponentForm([
{
key: 'display',
components: TabsEditDisplay
}
], ...extend);
}
</code></pre>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(1.1.0)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>
|
<div class="container">
<h2>GUI</h2>
<md-tab-group>
<md-tab *ngFor="let tab of tabs">
<template md-tab-label>{{tab.title}}</template>
<template md-tab-content>
<md-content class="md-padding">{{tab.content}}</md-content>
</template>
</md-tab>
</md-tab-group>
<form (submit)="addTab(label.value,content.value)" layout="column" class="md-padding">
<h2>Add a new Tab:</h2>
<div layout="row" layout-sm="column">
<md-input #label placeholder="Label"></md-input>
<md-input #content placeholder="Content"></md-input>
<button md-raised-button class="md-primary"
[disabled]="!label.value || !content.value" type="submit">
Add Tab
</button>
</div>
</form>
<br/><br/>
<div class="card" style="margin-top:50px;">
<form type="submit">
<table>
<tr>
<td><input type="number" value={{param1}} placeholder="param1" (input)="param1 = isNum($event.target.value)"/></td>
<td><input type="number" value={{param2}} placeholder="param2" (input)="param2 = isNum($event.target.value)"/></td>
<td><input type="date" value={{param3}} placeholder="param2" (input)="param3 = $event.target.value"/></td>
</tr>
<tr>
<td><a [routerLink]="['/mirek']">Show Sliders</a></td>
<td><button (click)="summe()">Summe</button></td>
<td><h4>Summe: {{summeadd}}</h4></td>
</tr>
</table>
</form>
</div>
<md-datepicker md-placeholder="Enter start date"></md-datepicker>
</div>
|
{#
Copyright (c) 2015 The Pycroft Authors. See the AUTHORS file.
This file is part of the Pycroft project and licensed under the terms of
the Apache License, Version 2.0. See the LICENSE file for details.
#}
{% extends "layout.html" %}
{% block content %}
<section id="tbl_bank_accounts">
<h2 class="page-header">{{ _("Übersicht") }}</h2>
{{ bank_account_table.render('bank_accounts') }}
</section>
<section>
<h2 class="page-header">{{ _("Unzugeordnete Kontobewegungen") }}</h2>
<a href="{{ url_for('.bank_account_activities_match') }}" class="btn btn-primary">Kontobewegungen matchen</a>
{{ bank_account_activity_table.render('bank_accounts_activities') }}
</section>
{% endblock %}
|
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>GGTK: The GO Graph Took Kit for working with the Gene Ontology: LinSimilarity Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GGTK: The GO Graph Took Kit for working with the Gene Ontology
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classLinSimilarity.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classLinSimilarity-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LinSimilarity Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class to calculate Lin similarity between 2 terms.
<a href="classLinSimilarity.html#details">More...</a></p>
<p><code>#include <<a class="el" href="LinSimilarity_8hpp_source.html">ggtk/LinSimilarity.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for LinSimilarity:</div>
<div class="dyncontent">
<div class="center">
<img src="classLinSimilarity.png" usemap="#LinSimilarity_map" alt=""/>
<map id="LinSimilarity_map" name="LinSimilarity_map">
<area href="classTermSimilarityInterface.html" title="An interface class for comparing semantic similarity of GO terms. " alt="TermSimilarityInterface" shape="rect" coords="0,0,141,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a44739dba8ae706d5248615bd9df9cc31"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLinSimilarity.html#a44739dba8ae706d5248615bd9df9cc31">LinSimilarity</a> (<a class="el" href="classGoGraph.html">GoGraph</a> *goGraph, <a class="el" href="classTermInformationContentMap.html">TermInformationContentMap</a> &icMap)</td></tr>
<tr class="memdesc:a44739dba8ae706d5248615bd9df9cc31"><td class="mdescLeft"> </td><td class="mdescRight">A constructor. <a href="#a44739dba8ae706d5248615bd9df9cc31">More...</a><br /></td></tr>
<tr class="separator:a44739dba8ae706d5248615bd9df9cc31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55d2d8bd6aea6fc3e9b0920f05828a15"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classLinSimilarity.html#a55d2d8bd6aea6fc3e9b0920f05828a15">calculateTermSimilarity</a> (std::string goTermA, std::string goTermB)</td></tr>
<tr class="memdesc:a55d2d8bd6aea6fc3e9b0920f05828a15"><td class="mdescLeft"> </td><td class="mdescRight">A method for calculating term-to-term similarity for <a class="el" href="namespaceGO.html" title="GO namespaces. ">GO</a> terms using Lin similarity. <a href="#a55d2d8bd6aea6fc3e9b0920f05828a15">More...</a><br /></td></tr>
<tr class="separator:a55d2d8bd6aea6fc3e9b0920f05828a15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a576df5bf234556e57e2ddcfda3d73b93"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classLinSimilarity.html#a576df5bf234556e57e2ddcfda3d73b93">calculateNormalizedTermSimilarity</a> (std::string goTermA, std::string goTermB)</td></tr>
<tr class="memdesc:a576df5bf234556e57e2ddcfda3d73b93"><td class="mdescLeft"> </td><td class="mdescRight">A method for calculating term-to-term similarity for <a class="el" href="namespaceGO.html" title="GO namespaces. ">GO</a> terms using Normalized Lin similarity. <a href="#a576df5bf234556e57e2ddcfda3d73b93">More...</a><br /></td></tr>
<tr class="separator:a576df5bf234556e57e2ddcfda3d73b93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2e39eac3cf61be4e1b44b988fa6f490"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classLinSimilarity.html#ab2e39eac3cf61be4e1b44b988fa6f490">getMICA</a> (boost::unordered_set< std::string > &ancestorsA, boost::unordered_set< std::string > &ancestorsB)</td></tr>
<tr class="memdesc:ab2e39eac3cf61be4e1b44b988fa6f490"><td class="mdescLeft"> </td><td class="mdescRight">A method for calculating the most informative common ancestor. <a href="#ab2e39eac3cf61be4e1b44b988fa6f490">More...</a><br /></td></tr>
<tr class="separator:ab2e39eac3cf61be4e1b44b988fa6f490"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class to calculate Lin similarity between 2 terms. </p>
<p>This class calculates Lin similarity.</p>
<p>Lin, D. (1998) An information theoretic definition of similarity. In: Proc. of the 15th Inernational Conference on Machine Learning. San Franscisco, CA: Morgan Kaufman. pp 296-304</p>
<p>P. W. Lord, R. D. Stevens, A. Brass, and C. A. Goble, "Semantic similarity measures as tools for exploring the gene ontology," Pac Symp Biocomput, pp. 601-12, 2003.</p>
<p>2 * IC(MICA) / ( IC(termA) + IC(termB) ) </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a44739dba8ae706d5248615bd9df9cc31"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LinSimilarity::LinSimilarity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGoGraph.html">GoGraph</a> * </td>
<td class="paramname"><em>goGraph</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTermInformationContentMap.html">TermInformationContentMap</a> & </td>
<td class="paramname"><em>icMap</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A constructor. </p>
<p>Creates the <a class="el" href="classLinSimilarity.html" title="A class to calculate Lin similarity between 2 terms. ">LinSimilarity</a> calculator </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a576df5bf234556e57e2ddcfda3d73b93"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double LinSimilarity::calculateNormalizedTermSimilarity </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>goTermA</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>goTermB</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A method for calculating term-to-term similarity for <a class="el" href="namespaceGO.html" title="GO namespaces. ">GO</a> terms using Normalized Lin similarity. </p>
<p>This method returns the Lin similarity scaled between 0 and 1 [0,1] inclusive </p>
<p>Implements <a class="el" href="classTermSimilarityInterface.html#aa46b7870c7725faab85ec502a3e5242d">TermSimilarityInterface</a>.</p>
</div>
</div>
<a class="anchor" id="a55d2d8bd6aea6fc3e9b0920f05828a15"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double LinSimilarity::calculateTermSimilarity </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>goTermA</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>goTermB</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A method for calculating term-to-term similarity for <a class="el" href="namespaceGO.html" title="GO namespaces. ">GO</a> terms using Lin similarity. </p>
<p>This method returns the Lin similarity. </p>
<p>Implements <a class="el" href="classTermSimilarityInterface.html#ae3474adcfcb02faef65ed5e16ef4db47">TermSimilarityInterface</a>.</p>
</div>
</div>
<a class="anchor" id="ab2e39eac3cf61be4e1b44b988fa6f490"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string LinSimilarity::getMICA </td>
<td>(</td>
<td class="paramtype">boost::unordered_set< std::string > & </td>
<td class="paramname"><em>ancestorsA</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::unordered_set< std::string > & </td>
<td class="paramname"><em>ancestorsB</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A method for calculating the most informative common ancestor. </p>
<p>This method searches the sets to determine the most informatics ancestor. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ggtk/<a class="el" href="LinSimilarity_8hpp_source.html">LinSimilarity.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classLinSimilarity.html">LinSimilarity</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>
|
---
layout: default
title: 404 - Page not found
permalink: /404.html
---
<div class="text-center">
<h1>Whoops, this page doesn't exist.</h1>
<h1>Move along. (404 error)</h1>
<br/>
<img src="{{ 'img/404-cute-sloth.jpg' | relative_url }}" />
</div>
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>npyscreen.Popup</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="npyscreen-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="npyscreen-module.html">Package npyscreen</a> ::
Module Popup
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="npyscreen.Popup-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="npyscreen.Popup-module.html">Module npyscreen.Popup</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment">#!/usr/bin/python</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># encoding: utf-8</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">os</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Module npyscreen.Form=npyscreen.Form-module.html,Class npyscreen.Form.Form=npyscreen.Form.Form-class.html"><a title="npyscreen.Form
npyscreen.Form.Form" class="py-name" href="#" onclick="return doclink('link-0', 'Form', 'link-0');">Form</a></tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Module npyscreen.ActionForm=npyscreen.ActionForm-module.html,Class npyscreen.ActionForm.ActionForm=npyscreen.ActionForm.ActionForm-class.html"><a title="npyscreen.ActionForm
npyscreen.ActionForm.ActionForm" class="py-name" href="#" onclick="return doclink('link-1', 'ActionForm', 'link-1');">ActionForm</a></tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">curses</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Module npyscreen.multiline=npyscreen.multiline-module.html"><a title="npyscreen.multiline" class="py-name" href="#" onclick="return doclink('link-2', 'multiline', 'link-2');">multiline</a></tt> </tt>
<a name="L10"></a><tt class="py-lineno">10</tt> <tt class="py-line"> </tt>
<a name="Popup"></a><div id="Popup-def"><a name="L11"></a><tt class="py-lineno">11</tt> <a class="py-toggle" href="#" id="Popup-toggle" onclick="return toggle('Popup');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="npyscreen.Popup.Popup-class.html">Popup</a><tt class="py-op">(</tt><tt class="py-base-class">Form</tt><tt class="py-op">.</tt><tt class="py-base-class">Form</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Popup-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="Popup-expanded"><a name="Popup.__init__"></a><div id="Popup.__init__-def"><a name="L12"></a><tt class="py-lineno">12</tt> <a class="py-toggle" href="#" id="Popup.__init__-toggle" onclick="return toggle('Popup.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="npyscreen.Popup.Popup-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">lines</tt> <tt class="py-op">=</tt> <tt class="py-number">12</tt><tt class="py-op">,</tt> <tt class="py-param">columns</tt><tt class="py-op">=</tt><tt class="py-number">60</tt><tt class="py-op">,</tt> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt> <tt class="py-line"> <tt class="py-param">minimum_lines</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"> <tt class="py-param">minimum_columns</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">keywords</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Popup.__init__-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="Popup.__init__-expanded"><a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-3" class="py-name" targets="Module npyscreen.Popup=npyscreen.Popup-module.html,Class npyscreen.Popup.Popup=npyscreen.Popup.Popup-class.html"><a title="npyscreen.Popup
npyscreen.Popup.Popup" class="py-name" href="#" onclick="return doclink('link-3', 'Popup', 'link-3');">Popup</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Method npyscreen.Form.Form.__init__()=npyscreen.Form.Form-class.html#__init__,Method npyscreen.FormWithMenus.ActionFormWithMenus.__init__()=npyscreen.FormWithMenus.ActionFormWithMenus-class.html#__init__,Method npyscreen.FormWithMenus.FormWithMenus.__init__()=npyscreen.FormWithMenus.FormWithMenus-class.html#__init__,Method npyscreen.Menu.Menu.__init__()=npyscreen.Menu.Menu-class.html#__init__,Method npyscreen.MenuScreen.MenuScreen.__init__()=npyscreen.MenuScreen.MenuScreen-class.html#__init__,Method npyscreen.NMenuDisplay.MenuDisplay.__init__()=npyscreen.NMenuDisplay.MenuDisplay-class.html#__init__,Method npyscreen.NPSAppManaged.NPSAppManaged.__init__()=npyscreen.NPSAppManaged.NPSAppManaged-class.html#__init__,Method npyscreen.NewMenu.MenuItem.__init__()=npyscreen.NewMenu.MenuItem-class.html#__init__,Method npyscreen.NewMenu.NewMenu.__init__()=npyscreen.NewMenu.NewMenu-class.html#__init__,Method npyscreen.Popup.ActionPopup.__init__()=npyscreen.Popup.ActionPopup-class.html#__init__,Method npyscreen.Popup.MessagePopup.__init__()=npyscreen.Popup.MessagePopup-class.html#__init__,Method npyscreen.Popup.Popup.__init__()=npyscreen.Popup.Popup-class.html#__init__,Method npyscreen.button.MiniButton.__init__()=npyscreen.button.MiniButton-class.html#__init__,Method npyscreen.checkbox.Checkbox.__init__()=npyscreen.checkbox.Checkbox-class.html#__init__,Method npyscreen.combobox.ComboBox.__init__()=npyscreen.combobox.ComboBox-class.html#__init__,Method npyscreen.datecombo.DateCombo.__init__()=npyscreen.datecombo.DateCombo-class.html#__init__,Method npyscreen.editmultiline.MultiLineEdit.__init__()=npyscreen.editmultiline.MultiLineEdit-class.html#__init__,Method npyscreen.monthbox.DateEntryBase.__init__()=npyscreen.monthbox.DateEntryBase-class.html#__init__,Method npyscreen.monthbox.MonthBox.__init__()=npyscreen.monthbox.MonthBox-class.html#__init__,Method npyscreen.multiline.MultiLine.__init__()=npyscreen.multiline.MultiLine-class.html#__init__,Method npyscreen.screen_area.ScreenArea.__init__()=npyscreen.screen_area.ScreenArea-class.html#__init__,Method npyscreen.slider.Slider.__init__()=npyscreen.slider.Slider-class.html#__init__,Method npyscreen.textbox.Textfield.__init__()=npyscreen.textbox.Textfield-class.html#__init__,Method npyscreen.titlefield.TitleText.__init__()=npyscreen.titlefield.TitleText-class.html#__init__,Method npyscreen.widget.Widget.__init__()=npyscreen.widget.Widget-class.html#__init__"><a title="npyscreen.Form.Form.__init__
npyscreen.FormWithMenus.ActionFormWithMenus.__init__
npyscreen.FormWithMenus.FormWithMenus.__init__
npyscreen.Menu.Menu.__init__
npyscreen.MenuScreen.MenuScreen.__init__
npyscreen.NMenuDisplay.MenuDisplay.__init__
npyscreen.NPSAppManaged.NPSAppManaged.__init__
npyscreen.NewMenu.MenuItem.__init__
npyscreen.NewMenu.NewMenu.__init__
npyscreen.Popup.ActionPopup.__init__
npyscreen.Popup.MessagePopup.__init__
npyscreen.Popup.Popup.__init__
npyscreen.button.MiniButton.__init__
npyscreen.checkbox.Checkbox.__init__
npyscreen.combobox.ComboBox.__init__
npyscreen.datecombo.DateCombo.__init__
npyscreen.editmultiline.MultiLineEdit.__init__
npyscreen.monthbox.DateEntryBase.__init__
npyscreen.monthbox.MonthBox.__init__
npyscreen.multiline.MultiLine.__init__
npyscreen.screen_area.ScreenArea.__init__
npyscreen.slider.Slider.__init__
npyscreen.textbox.Textfield.__init__
npyscreen.titlefield.TitleText.__init__
npyscreen.widget.Widget.__init__" class="py-name" href="#" onclick="return doclink('link-4', '__init__', 'link-4');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-name">lines</tt><tt class="py-op">,</tt> <tt class="py-name">columns</tt><tt class="py-op">=</tt><tt class="py-name">columns</tt><tt class="py-op">,</tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt> <tt class="py-line"> <tt class="py-name">minimum_columns</tt><tt class="py-op">=</tt><tt class="py-number">40</tt><tt class="py-op">,</tt> <tt class="py-name">minimum_lines</tt><tt class="py-op">=</tt><tt class="py-number">8</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">keywords</tt><tt class="py-op">)</tt> </tt>
<a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">show_atx</tt> <tt class="py-op">=</tt> <tt class="py-number">10</tt> </tt>
<a name="L19"></a><tt class="py-lineno">19</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">show_aty</tt> <tt class="py-op">=</tt> <tt class="py-number">2</tt> </tt>
</div></div><a name="L20"></a><tt class="py-lineno">20</tt> <tt class="py-line"> </tt>
<a name="ActionPopup"></a><div id="ActionPopup-def"><a name="L21"></a><tt class="py-lineno">21</tt> <a class="py-toggle" href="#" id="ActionPopup-toggle" onclick="return toggle('ActionPopup');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="npyscreen.Popup.ActionPopup-class.html">ActionPopup</a><tt class="py-op">(</tt><tt class="py-base-class">ActionForm</tt><tt class="py-op">.</tt><tt class="py-base-class">ActionForm</tt><tt class="py-op">,</tt> <tt class="py-base-class">Popup</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ActionPopup-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="ActionPopup-expanded"><a name="ActionPopup.__init__"></a><div id="ActionPopup.__init__-def"><a name="L22"></a><tt class="py-lineno">22</tt> <a class="py-toggle" href="#" id="ActionPopup.__init__-toggle" onclick="return toggle('ActionPopup.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="npyscreen.Popup.ActionPopup-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">keywords</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ActionPopup.__init__-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="ActionPopup.__init__-expanded"><a name="L23"></a><tt class="py-lineno">23</tt> <tt class="py-line"> <tt id="link-5" class="py-name"><a title="npyscreen.Popup
npyscreen.Popup.Popup" class="py-name" href="#" onclick="return doclink('link-5', 'Popup', 'link-3');">Popup</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="npyscreen.Form.Form.__init__
npyscreen.FormWithMenus.ActionFormWithMenus.__init__
npyscreen.FormWithMenus.FormWithMenus.__init__
npyscreen.Menu.Menu.__init__
npyscreen.MenuScreen.MenuScreen.__init__
npyscreen.NMenuDisplay.MenuDisplay.__init__
npyscreen.NPSAppManaged.NPSAppManaged.__init__
npyscreen.NewMenu.MenuItem.__init__
npyscreen.NewMenu.NewMenu.__init__
npyscreen.Popup.ActionPopup.__init__
npyscreen.Popup.MessagePopup.__init__
npyscreen.Popup.Popup.__init__
npyscreen.button.MiniButton.__init__
npyscreen.checkbox.Checkbox.__init__
npyscreen.combobox.ComboBox.__init__
npyscreen.datecombo.DateCombo.__init__
npyscreen.editmultiline.MultiLineEdit.__init__
npyscreen.monthbox.DateEntryBase.__init__
npyscreen.monthbox.MonthBox.__init__
npyscreen.multiline.MultiLine.__init__
npyscreen.screen_area.ScreenArea.__init__
npyscreen.slider.Slider.__init__
npyscreen.textbox.Textfield.__init__
npyscreen.titlefield.TitleText.__init__
npyscreen.widget.Widget.__init__" class="py-name" href="#" onclick="return doclink('link-6', '__init__', 'link-4');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">keywords</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L24"></a><tt class="py-lineno">24</tt> <tt class="py-line"> </tt>
<a name="MessagePopup"></a><div id="MessagePopup-def"><a name="L25"></a><tt class="py-lineno">25</tt> <a class="py-toggle" href="#" id="MessagePopup-toggle" onclick="return toggle('MessagePopup');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="npyscreen.Popup.MessagePopup-class.html">MessagePopup</a><tt class="py-op">(</tt><tt class="py-base-class">Popup</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="MessagePopup-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="MessagePopup-expanded"><a name="MessagePopup.__init__"></a><div id="MessagePopup.__init__-def"><a name="L26"></a><tt class="py-lineno">26</tt> <a class="py-toggle" href="#" id="MessagePopup.__init__-toggle" onclick="return toggle('MessagePopup.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="npyscreen.Popup.MessagePopup-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">keywords</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="MessagePopup.__init__-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="MessagePopup.__init__-expanded"><a name="L27"></a><tt class="py-lineno">27</tt> <tt class="py-line"> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-7" class="py-name" targets="Class npyscreen.Popup.MessagePopup=npyscreen.Popup.MessagePopup-class.html"><a title="npyscreen.Popup.MessagePopup" class="py-name" href="#" onclick="return doclink('link-7', 'MessagePopup', 'link-7');">MessagePopup</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name"><a title="npyscreen.Form.Form.__init__
npyscreen.FormWithMenus.ActionFormWithMenus.__init__
npyscreen.FormWithMenus.FormWithMenus.__init__
npyscreen.Menu.Menu.__init__
npyscreen.MenuScreen.MenuScreen.__init__
npyscreen.NMenuDisplay.MenuDisplay.__init__
npyscreen.NPSAppManaged.NPSAppManaged.__init__
npyscreen.NewMenu.MenuItem.__init__
npyscreen.NewMenu.NewMenu.__init__
npyscreen.Popup.ActionPopup.__init__
npyscreen.Popup.MessagePopup.__init__
npyscreen.Popup.Popup.__init__
npyscreen.button.MiniButton.__init__
npyscreen.checkbox.Checkbox.__init__
npyscreen.combobox.ComboBox.__init__
npyscreen.datecombo.DateCombo.__init__
npyscreen.editmultiline.MultiLineEdit.__init__
npyscreen.monthbox.DateEntryBase.__init__
npyscreen.monthbox.MonthBox.__init__
npyscreen.multiline.MultiLine.__init__
npyscreen.screen_area.ScreenArea.__init__
npyscreen.slider.Slider.__init__
npyscreen.textbox.Textfield.__init__
npyscreen.titlefield.TitleText.__init__
npyscreen.widget.Widget.__init__" class="py-name" href="#" onclick="return doclink('link-8', '__init__', 'link-4');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">keywords</tt><tt class="py-op">)</tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">TextWidget</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt id="link-9" class="py-name"><a title="npyscreen.multiline" class="py-name" href="#" onclick="return doclink('link-9', 'multiline', 'link-2');">multiline</a></tt><tt class="py-op">.</tt><tt id="link-10" class="py-name" targets="Class npyscreen.multiline.Pager=npyscreen.multiline.Pager-class.html"><a title="npyscreen.multiline.Pager" class="py-name" href="#" onclick="return doclink('link-10', 'Pager', 'link-10');">Pager</a></tt><tt class="py-op">,</tt> <tt class="py-name">scroll_exit</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">max_height</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Method npyscreen.screen_area.ScreenArea.widget_useable_space()=npyscreen.screen_area.ScreenArea-class.html#widget_useable_space"><a title="npyscreen.screen_area.ScreenArea.widget_useable_space" class="py-name" href="#" onclick="return doclink('link-11', 'widget_useable_space', 'link-11');">widget_useable_space</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L29"></a><tt class="py-lineno">29</tt> <tt class="py-line"> </tt>
<a name="main"></a><div id="main-def"><a name="L30"></a><tt class="py-lineno">30</tt> <a class="py-toggle" href="#" id="main-toggle" onclick="return toggle('main');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="npyscreen.Popup-module.html#main">main</a><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="main-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="main-expanded"><a name="L31"></a><tt class="py-lineno">31</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt id="link-12" class="py-name" targets="Module npyscreen.titlefield=npyscreen.titlefield-module.html"><a title="npyscreen.titlefield" class="py-name" href="#" onclick="return doclink('link-12', 'titlefield', 'link-12');">titlefield</a></tt> </tt>
<a name="L32"></a><tt class="py-lineno">32</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt id="link-13" class="py-name" targets="Module npyscreen.textbox=npyscreen.textbox-module.html"><a title="npyscreen.textbox" class="py-name" href="#" onclick="return doclink('link-13', 'textbox', 'link-13');">textbox</a></tt> </tt>
<a name="L33"></a><tt class="py-lineno">33</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt id="link-14" class="py-name" targets="Module npyscreen.slider=npyscreen.slider-module.html"><a title="npyscreen.slider" class="py-name" href="#" onclick="return doclink('link-14', 'slider', 'link-14');">slider</a></tt> </tt>
<a name="L34"></a><tt class="py-lineno">34</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt id="link-15" class="py-name"><a title="npyscreen.multiline" class="py-name" href="#" onclick="return doclink('link-15', 'multiline', 'link-2');">multiline</a></tt> </tt>
<a name="L35"></a><tt class="py-lineno">35</tt> <tt class="py-line"> </tt>
<a name="L36"></a><tt class="py-lineno">36</tt> <tt class="py-line"> </tt>
<a name="L37"></a><tt class="py-lineno">37</tt> <tt class="py-line"> <tt class="py-name">F</tt> <tt class="py-op">=</tt> <tt id="link-16" class="py-name"><a title="npyscreen.Popup
npyscreen.Popup.Popup" class="py-name" href="#" onclick="return doclink('link-16', 'Popup', 'link-3');">Popup</a></tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">=</tt><tt class="py-string">"Testing"</tt><tt class="py-op">)</tt> </tt>
<a name="L38"></a><tt class="py-lineno">38</tt> <tt class="py-line"> <tt class="py-name">w</tt> <tt class="py-op">=</tt> <tt class="py-name">F</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name" targets="Method npyscreen.Form.Form.add_widget()=npyscreen.Form.Form-class.html#add_widget"><a title="npyscreen.Form.Form.add_widget" class="py-name" href="#" onclick="return doclink('link-17', 'add_widget', 'link-17');">add_widget</a></tt><tt class="py-op">(</tt><tt id="link-18" class="py-name"><a title="npyscreen.titlefield" class="py-name" href="#" onclick="return doclink('link-18', 'titlefield', 'link-12');">titlefield</a></tt><tt class="py-op">.</tt><tt id="link-19" class="py-name" targets="Class npyscreen.titlefield.TitleText=npyscreen.titlefield.TitleText-class.html"><a title="npyscreen.titlefield.TitleText" class="py-name" href="#" onclick="return doclink('link-19', 'TitleText', 'link-19');">TitleText</a></tt><tt class="py-op">)</tt> </tt>
<a name="L39"></a><tt class="py-lineno">39</tt> <tt class="py-line"> <tt class="py-name">str</tt> <tt class="py-op">=</tt> <tt class="py-string">"useable space = %s, %s; my height and width is: %s, %s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">F</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="npyscreen.screen_area.ScreenArea.widget_useable_space" class="py-name" href="#" onclick="return doclink('link-20', 'widget_useable_space', 'link-11');">widget_useable_space</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">F</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="npyscreen.screen_area.ScreenArea.widget_useable_space" class="py-name" href="#" onclick="return doclink('link-21', 'widget_useable_space', 'link-11');">widget_useable_space</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">w</tt><tt class="py-op">.</tt><tt class="py-name">height</tt><tt class="py-op">,</tt> <tt class="py-name">w</tt><tt class="py-op">.</tt><tt class="py-name">width</tt><tt class="py-op">)</tt> </tt>
<a name="L40"></a><tt class="py-lineno">40</tt> <tt class="py-line"> <tt class="py-name">w</tt><tt class="py-op">.</tt><tt id="link-22" class="py-name" targets="Variable npyscreen.slider.Slider.value=npyscreen.slider.Slider-class.html#value,Variable npyscreen.titlefield.TitleText.value=npyscreen.titlefield.TitleText-class.html#value"><a title="npyscreen.slider.Slider.value
npyscreen.titlefield.TitleText.value" class="py-name" href="#" onclick="return doclink('link-22', 'value', 'link-22');">value</a></tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt> </tt>
<a name="L41"></a><tt class="py-lineno">41</tt> <tt class="py-line"> <tt class="py-name">F</tt><tt class="py-op">.</tt><tt class="py-name">nextrely</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L42"></a><tt class="py-lineno">42</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">F</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="npyscreen.Form.Form.add_widget" class="py-name" href="#" onclick="return doclink('link-23', 'add_widget', 'link-17');">add_widget</a></tt><tt class="py-op">(</tt><tt id="link-24" class="py-name"><a title="npyscreen.slider" class="py-name" href="#" onclick="return doclink('link-24', 'slider', 'link-14');">slider</a></tt><tt class="py-op">.</tt><tt id="link-25" class="py-name" targets="Class npyscreen.slider.Slider=npyscreen.slider.Slider-class.html"><a title="npyscreen.slider.Slider" class="py-name" href="#" onclick="return doclink('link-25', 'Slider', 'link-25');">Slider</a></tt><tt class="py-op">,</tt> <tt class="py-name">out_of</tt><tt class="py-op">=</tt><tt class="py-number">10</tt><tt class="py-op">)</tt> </tt>
<a name="L43"></a><tt class="py-lineno">43</tt> <tt class="py-line"> <tt class="py-name">F</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name" targets="Method npyscreen.ActionForm.ActionForm.edit()=npyscreen.ActionForm.ActionForm-class.html#edit,Method npyscreen.Form.Form.edit()=npyscreen.Form.Form-class.html#edit,Method npyscreen.Menu.Menu.edit()=npyscreen.Menu.Menu-class.html#edit,Method npyscreen.NMenuDisplay.MenuDisplay.edit()=npyscreen.NMenuDisplay.MenuDisplay-class.html#edit,Method npyscreen.combobox.ComboBox.edit()=npyscreen.combobox.ComboBox-class.html#edit,Method npyscreen.datecombo.DateCombo.edit()=npyscreen.datecombo.DateCombo-class.html#edit,Method npyscreen.multiline.MultiLine.edit()=npyscreen.multiline.MultiLine-class.html#edit,Method npyscreen.multiline.Pager.edit()=npyscreen.multiline.Pager-class.html#edit,Method npyscreen.textbox.FixedText.edit()=npyscreen.textbox.FixedText-class.html#edit,Method npyscreen.textbox.Textfield.edit()=npyscreen.textbox.Textfield-class.html#edit,Method npyscreen.titlefield.TitleText.edit()=npyscreen.titlefield.TitleText-class.html#edit,Method npyscreen.widget.Widget.edit()=npyscreen.widget.Widget-class.html#edit"><a title="npyscreen.ActionForm.ActionForm.edit
npyscreen.Form.Form.edit
npyscreen.Menu.Menu.edit
npyscreen.NMenuDisplay.MenuDisplay.edit
npyscreen.combobox.ComboBox.edit
npyscreen.datecombo.DateCombo.edit
npyscreen.multiline.MultiLine.edit
npyscreen.multiline.Pager.edit
npyscreen.textbox.FixedText.edit
npyscreen.textbox.Textfield.edit
npyscreen.titlefield.TitleText.edit
npyscreen.widget.Widget.edit" class="py-name" href="#" onclick="return doclink('link-26', 'edit', 'link-26');">edit</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L44"></a><tt class="py-lineno">44</tt> <tt class="py-line"> </tt>
<a name="MessageTest"></a><div id="MessageTest-def"><a name="L45"></a><tt class="py-lineno">45</tt> <a class="py-toggle" href="#" id="MessageTest-toggle" onclick="return toggle('MessageTest');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="npyscreen.Popup-module.html#MessageTest">MessageTest</a><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="MessageTest-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="MessageTest-expanded"><a name="L46"></a><tt class="py-lineno">46</tt> <tt class="py-line"> <tt class="py-name">F</tt> <tt class="py-op">=</tt> <tt id="link-27" class="py-name"><a title="npyscreen.Popup.MessagePopup" class="py-name" href="#" onclick="return doclink('link-27', 'MessagePopup', 'link-7');">MessagePopup</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L47"></a><tt class="py-lineno">47</tt> <tt class="py-line"> <tt class="py-name">F</tt><tt class="py-op">.</tt><tt class="py-name">TextWidget</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name" targets="Variable npyscreen.combobox.TitleCombo.values=npyscreen.combobox.TitleCombo-class.html#values,Variable npyscreen.multiline.TitleMultiLine.values=npyscreen.multiline.TitleMultiLine-class.html#values"><a title="npyscreen.combobox.TitleCombo.values
npyscreen.multiline.TitleMultiLine.values" class="py-name" href="#" onclick="return doclink('link-28', 'values', 'link-28');">values</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">"This is a "</tt><tt class="py-op">,</tt> <tt class="py-string">"very quick test"</tt><tt class="py-op">,</tt> <tt class="py-string">"of a very useful"</tt><tt class="py-op">,</tt> <tt class="py-string">"widget"</tt><tt class="py-op">,</tt> <tt class="py-string">"One"</tt><tt class="py-op">,</tt><tt class="py-string">"Two"</tt><tt class="py-op">,</tt><tt class="py-string">"Three"</tt><tt class="py-op">,</tt><tt class="py-string">"Four"</tt><tt class="py-op">,</tt><tt class="py-string">"Five"</tt><tt class="py-op">]</tt> </tt>
<a name="L48"></a><tt class="py-lineno">48</tt> <tt class="py-line"> <tt class="py-name">F</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="npyscreen.ActionForm.ActionForm.edit
npyscreen.Form.Form.edit
npyscreen.Menu.Menu.edit
npyscreen.NMenuDisplay.MenuDisplay.edit
npyscreen.combobox.ComboBox.edit
npyscreen.datecombo.DateCombo.edit
npyscreen.multiline.MultiLine.edit
npyscreen.multiline.Pager.edit
npyscreen.textbox.FixedText.edit
npyscreen.textbox.Textfield.edit
npyscreen.titlefield.TitleText.edit
npyscreen.widget.Widget.edit" class="py-name" href="#" onclick="return doclink('link-29', 'edit', 'link-26');">edit</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L49"></a><tt class="py-lineno">49</tt> <tt class="py-line"> </tt>
<a name="L50"></a><tt class="py-lineno">50</tt> <tt class="py-line"><tt class="py-keyword">if</tt> <tt class="py-name">__name__</tt> <tt class="py-op">==</tt> <tt class="py-string">'__main__'</tt><tt class="py-op">:</tt> </tt>
<a name="L51"></a><tt class="py-lineno">51</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">curses</tt><tt class="py-op">.</tt><tt class="py-name">wrapper</tt> </tt>
<a name="L52"></a><tt class="py-lineno">52</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-30" class="py-name"><a title="npyscreen.Form
npyscreen.Form.Form" class="py-name" href="#" onclick="return doclink('link-30', 'Form', 'link-0');">Form</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L53"></a><tt class="py-lineno">53</tt> <tt class="py-line"> <tt class="py-name">curses</tt><tt class="py-op">.</tt><tt class="py-name">wrapper</tt><tt class="py-op">(</tt><tt class="py-name">MessageTest</tt><tt class="py-op">)</tt> </tt>
<a name="L54"></a><tt class="py-lineno">54</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="npyscreen-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Thu Mar 29 15:58:56 2007
</td>
<td align="right" class="footer">
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie()
// -->
</script>
</body>
</html>
|
<!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" lang="pt-br" xml:lang="pt-br">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="apple-itunes-app" content="app-id=1049343067" />
<meta name="google-play-app" content="app-id=br.leg.camara.infolegmovel" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<style type="text/css">@import url(http://www2.camara.leg.br/portal_css/camara_leg_tema/member-cachekey-6c543ad953036924bd56daf925f0a0f7.css);</style><style type="text/css">@import url(http://www2.camara.leg.br/portal_css/camara_leg_tema/portlets-cachekey-8b4e09b84ab18e364104300e45846246.css);</style><style type="text/css" media="screen">@import url(http://www2.camara.leg.br/portal_css/camara_leg_tema/deprecated-cachekey-c4217ac1fb05d762bbd4b1206e572cfa.css);</style><style type="text/css" media="screen">@import url(http://www2.camara.leg.br/portal_css/camara_leg_tema/resourceplone.app.discussion.stylesheetsdiscussion-cachekey-5d9e6a683850ba8cf51b12763f9b69df.css);</style><style type="text/css" media="screen">@import url(http://www2.camara.leg.br/portal_css/camara_leg_tema/colunas-cachekey-50f21a219775a45576e55e3899cf62ab.css);</style><style type="text/css" media="screen">@import url(http://www2.camara.leg.br/portal_css/camara_leg_tema/elements-cachekey-7f50620eecf53e93aae0596bdf2e51ff.css);</style><link rel="stylesheet" type="text/css" media="all" href="http://www2.camara.leg.br/portal_css/camara_leg_tema/smart-app-banner-cachekey-3ad3002cb55e53dc50dab38e5e7ae12b.css" /><link rel="stylesheet" type="text/css" href="http://www2.camara.leg.br/portal_css/camara_leg_tema/themecamara.leg.temacssbootstrap.min-cachekey-dabe3ae17f529886a3d7cace28fd3094.css" /><link rel="stylesheet" type="text/css" media="screen" href="http://www2.camara.leg.br/portal_css/camara_leg_tema/themecamara.leg.temacsssmart-app-banner-cachekey-20058cf977553c565df1742115543d87.css" /><link rel="shortcut icon" type="image/x-icon" href="http://www2.camara.leg.br/favicon.ico" /><link rel="apple-touch-icon" href="http://www2.camara.leg.br/touch_icon.png" /><link rel="search" href="http://www2.camara.leg.br/busca" title="Buscar neste site" /><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/resourceplone.app.jquery-cachekey-4e440b6a5393d75f6e92f27282b18c9b.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/styleswitcher-cachekey-a4c5483ff5c65c8382dcde19d19358be.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/impressaoIframes-cachekey-1481259676622bfbefe34fff1f7733b5.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/GoogleAnalyticsTracker.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/mensagemSaida-cachekey-561d0af91de97595a9767ea0afed31d5.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/kss-bbb-cachekey-4bcfca6ac5b617c3aab416c4efc90d37.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/inline_validation-cachekey-9259e3a1e6280374449091be123e6e97.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/themecamara.leg.temajsbootstrap.min-cachekey-9a678cf8fc2c69581c3a7ca7a00ac1c9.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/themecamara.leg.temajslibsmoment.min-cachekey-1d6bb52f5628a128f7c76dba9cc60d05.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/themecamara.leg.temajslibsmoment-pt-br-cachekey-fe839fbf3cc9ac9517dc805a9ba530ef.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/themecamara.leg.temajslibsbootstrap-datetimepicker.min-cachekey-e852dc569a3fd701b84b8e11cca12731.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/themecamara.leg.temajslibsjquery.maskedinput.min-cachekey-11ace5da95c916a13f94960493144483.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/themecamara.leg.temajslibssmart-app-banner-cachekey-ad50d1bb4507d36be871400ff528f0e4.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/themecamara.leg.temajsmobile-banner-cachekey-52a2b9cf7383b6aed1f8f08128ff4df5.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/themecamara.leg.temajsacoes-tema-cachekey-b313a71f80179e617087cda7f1e39813.js"></script><script type="text/javascript" src="http://www2.camara.leg.br/portal_javascripts/camara_leg_tema/themecamara.leg.temajscorrecoes-bootstrap-tema-cachekey-b1938086e20ec521ab5f03a1b1e3be13.js"></script><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><meta name="viewport" content="width=device-width, initial-scale=0.6666, maximum-scale=1.0, minimum-scale=0.6666" /><link rel="canonical" href="" /><script type="text/javascript">
$("link[rel='canonical']").attr("href", window.location.href);
</script>
<title>Câmara dos Deputados - Remuneração dos Servidores</title>
<script type="text/javascript">
<!--
function showRemuneracaoFolha(folhaId) {
setVisibilidadeRemuneracaoFolha(folhaId, true);
}
function hideRemuneracaoFolha(folhaId) {
setVisibilidadeRemuneracaoFolha(folhaId, false);
}
function setVisibilidadeRemuneracaoFolha(folhaId, visivel) {
document.getElementById(folhaId).style.display = visivel ? 'block' : 'none';
document.getElementById(folhaId + '_show').style.display = visivel ? 'none' : 'block';
document.getElementById(folhaId + '_hide').style.display = visivel ? 'block' : 'none';
}
//-->
</script>
</head>
<body>
<div id="portal-top" class="diazo_layouts_topo">
<div id="portal-header">
<div id="portal-topo-marcacao" class="home-Topo"><div id="portal-topo" class="home-Topo">
<div class="conteudo-fluido">
<div class="container">
<p class="hiddenStructure">
<a accesskey="2" href="#marcacao-conteudo-portal">Ir para o conteúdo.</a> |
<a accesskey="6" href="#portlet-navigation-tree">Ir para a navegação</a>
</p>
<div class="conteudo-topo-xs hidden-sm hidden-md hidden-lg">
<div class="row menu">
<div class="col-xs-2">
<div class="homeCamara-menuGeral-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#homeCamara-menuGeral-links" aria-expanded="false">
<span class="sr-only">Expandir Navegação</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
</div>
<div class="col-xs-8">
<a id="portal-logo-medio" title="Portal da Câmara dos Deputados" href="http://www2.camara.leg.br">
<img class="img-responsive" alt="Portal da Câmara dos Deputados" title="Portal da Câmara dos Deputados" src="http://www2.camara.leg.br/++theme++camara.leg.tema/imagens/svg/logo-medio.svg" />
</a>
</div>
<div class="col-xs-2">
<div class="pesquisaOculta-home hidden-sm hidden-md hidden-lg">
<span class="glyphicon glyphicon-search btn-md" aria-hidden="true"></span>
</div>
</div>
</div>
<div class="row pesquisa-xs" style="display:none;">
<div class="col-xs-12">
<form name="buscaCamara" action="http://www2.camara.leg.br/busca" id="buscaCamara">
<section class="flexbox">
<label for="searchGadget" class="hiddenStructure">Busca</label>
<div class="stretch">
<input name="q" id="searchGadget" type="text" placeholder="Buscar no portal" />
</div>
<div class="normal">
<button class="enviar-formulario-busca" type="submit">Buscar</button>
</div>
</section>
</form>
</div>
</div>
</div>
<div class="row conteudo-topo hidden-xs">
<div class="col-xs-2 col-sm-2 col-md-6">
<a id="portal-logo" class="hidden-xs hidden-sm" title="Portal da Câmara dos Deputados" href="http://www2.camara.leg.br">
<img alt="Portal da Câmara dos Deputados" title="Portal da Câmara dos Deputados" width="350" src="http://www2.camara.leg.br/++theme++camara.leg.tema/imagens/svg/logo.svg" />
</a>
<a id="portal-logo-medio" class="hidden-xs hidden-md hidden-lg" title="Portal da Câmara dos Deputados" href="http://www2.camara.leg.br">
<img alt="Portal da Câmara dos Deputados" title="Portal da Câmara dos Deputados" width="150" src="http://www2.camara.leg.br/++theme++camara.leg.tema/imagens/svg/logo-medio.svg" />
</a>
</div>
<div class="col-xs-10 col-sm-10 col-md-6">
<div class="links-pesquisa">
<div class="row">
<div class="col-sm-12 col-md-12 links-externos-home">
<a class="triggerPopOverVlibras" href="#" rel="popover" data-placement="bottom" data-trigger="focus" data-popover-content="#popOverVlibras">
<img title="Acessível em Libras" alt="Acessível em Libras" id="btn_acessivel_libras" width="26" src="http://www2.camara.leg.br/++theme++camara.leg.tema/imagens/svg/icones-home-vlibras.svg" />
</a>
<div id="popOverVlibras" class="hide">
<img class="animacao-gif-acessibilidade" alt="Acessível em Libras" title="Acessível em Libras" src="http://www2.camara.leg.br/++theme++camara.theme/imagens/animacao-acessivel-libras.gif" />
<p>O conteúdo deste portal pode ser acessível em Libras usando o <a href="http://www.vlibras.gov.br/">VLibras</a>.</p>
</div>
<span class="separador-links hidden-xs">|</span>
<a href="http://camara.custhelp.com" class="visualNoPrint link-comunicacao" title="Fale Conosco">
<span class="hidden-xs">Fale Conosco</span>
<img class="hidden-sm hidden-md hidden-lg" alt="Fale Conosco" src="http://www2.camara.leg.br/++theme++camara.leg.tema/imagens/svg/icones-home-email.svg" />
</a>
<span class="separador-links hidden-xs">|</span>
<a title="Lei de Acesso à Informação" class="visualNoPrint link-comunicacao" href="http://www2.camara.leg.br/transparencia/acesso-a-informacao">
<span class="hidden-xs">Acesso à Informação</span>
<img class="hidden-sm hidden-md hidden-lg" alt="Acesso à Informação" src="http://www2.camara.leg.br/++theme++camara.leg.tema/imagens/svg/icones-home-info.svg" />
</a>
<span class="separador-links hidden-xs">|</span>
<a class="link-congresso" title="Ir para o Congresso Nacional" alt="Ir para o sítio do Congresso Nacional" href="http://www.congressonacional.leg.br">
<img alt="Ir para o sítio do Congresso Nacional" src="http://www2.camara.leg.br/++theme++camara.leg.tema/imagens/svg/icones-home-congresso.svg" />
</a>
<a title="Ir para o Senado Federal" alt="Ir para o sítio do Senado Federal" class="visualNoPrint" href="http://www.senado.gov.br">
<img alt="Ir para o sítio do Senado Federal" src="http://www2.camara.leg.br/++theme++camara.leg.tema/imagens/svg/icones-home-senado.svg" />
</a>
<a title="Ir para o sítio do TCU - Tribunal de Contas da União" alt="Ir para o TCU - Tribunal de Contas da União" class="visualNoPrint" href="http://www.tcu.gov.br">
<img alt="Ir para o sítio do TCU - Tribunal de Contas da União" src="http://www2.camara.leg.br/++theme++camara.leg.tema/imagens/svg/icones-home-tcu.svg" />
</a>
</div>
<div class="col-sm-12 hidden-xs">
<div class="row pesquisa-home">
<form name="buscaCamara" class="buscaCamara" action="http://www2.camara.leg.br/busca" id="buscaCamara">
<div class="col-md-12">
<div class="blocoBuscaCamara">
<label for="searchGadget" class="hiddenStructure">Busca</label>
<input name="q" id="searchGadget" type="text" size="30" class="search-field" placeholder="Buscar no portal" />
<button class="enviar-formulario-busca" type="submit"><span class="glyphicon glyphicon-search btn-md" aria-hidden="true"></span></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div></div>
<div id="home-camara-menu" class="homeCamara-menuGeral-body homeCamara-menuGeral-body-marcacao">
<nav class="navbar-default">
<div class="container">
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="homeCamara-menuGeral-links" role="navigation">
<ul id="portal-globalnav" class="nav navbar-nav" aria-label="Navegação Global" role="menubar">
<li aria-haspopup="true" role="menuitem" class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" aria-label="Institucional">
Institucional
</a>
<ul class="submenu dropdown-menu" role="menu" aria-hidden="true">
<li>
<a href="http://www2.camara.leg.br/a-camara/conheca">Papel e história da Câmara</a>
</li>
<li>
<a href="http://www2.camara.leg.br/a-camara/estruturaadm">Estrutura organizacional</a>
</li>
<li>
<a href="http://www2.camara.leg.br/a-camara/cursos">Cursos</a>
</li>
<li>
<a href="http://www2.camara.leg.br/a-camara/programas-institucionais">Programas institucionais</a>
</li>
<li>
<a href="http://www2.camara.leg.br/a-camara/documentos-e-pesquisa">Publicações e acervos</a>
</li>
<li>
<a href="http://www2.camara.leg.br/a-camara/visiteacamara">Visite a Câmara</a>
</li>
</ul>
</li>
<li aria-haspopup="true" role="menuitem" class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" aria-label="Deputados">
Deputados
</a>
<ul class="submenu dropdown-menu" role="menu" aria-hidden="true">
<li>
<a href="http://www2.camara.leg.br/deputados/pesquisa">Conheça os Deputados</a>
</li>
<li>
<a href="http://www2.camara.leg.br/deputados/discursos-e-notas-taquigraficas">Discursos</a>
</li>
<li>
<a href="http://www2.camara.leg.br/deputados/liderancas-partidarias">Lideranças partidárias</a>
</li>
<li>
<a href="http://www2.camara.leg.br/deputados/frentes-e-grupos-parlamentares">Frentes e grupos parlamentares</a>
</li>
</ul>
</li>
<li aria-haspopup="true" role="menuitem" class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" aria-label="Atividade Legislativa">
Atividade Legislativa
</a>
<ul class="submenu dropdown-menu" role="menu" aria-hidden="true">
<li>
<a href="http://www2.camara.leg.br/atividade-legislativa/agenda">Agenda</a>
</li>
<li>
<a href="http://www2.camara.leg.br/atividade-legislativa/plenario">Plenário</a>
</li>
<li>
<a href="http://www2.camara.leg.br/atividade-legislativa/comissoes">Comissões</a>
</li>
<li>
<a href="http://www2.camara.leg.br/atividade-legislativa/projetos-de-lei-e-outras-proposicoes">Projetos de lei e outras proposições</a>
</li>
<li>
<a href="http://www2.camara.leg.br/atividade-legislativa/legislacao">Legislação</a>
</li>
</ul>
</li>
<li aria-haspopup="true" role="menuitem" class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" aria-label="Orçamento da União">
Orçamento da União
</a>
<ul class="submenu dropdown-menu" role="menu" aria-hidden="true">
<li>
<a href="http://www2.camara.leg.br/orcamento-da-uniao/leis-orcamentarias">Leis orçamentárias</a>
</li>
<li>
<a href="http://www2.camara.leg.br/orcamento-da-uniao/fiscalize">Fiscalize</a>
</li>
</ul>
</li>
<li aria-haspopup="true" role="menuitem" class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" aria-label="Transparência">
Transparência
</a>
<ul class="submenu dropdown-menu" role="menu" aria-hidden="true">
<li>
<a href="http://www2.camara.leg.br/transparencia/acesso-a-informacao">Acesso à Informação</a>
</li>
<li>
<a href="http://www2.camara.leg.br/transparencia/cota-para-exercicio-da-atividade-parlamentar">Cota Parlamentar</a>
</li>
<li>
<a href="http://www2.camara.leg.br/transparencia/viagens-oficiais-e-passaportes">Viagens oficiais e passaportes</a>
</li>
<li>
<a href="http://www2.camara.leg.br/transparencia/imoveis-funcionais-e-auxilio-moradia">Imóveis funcionais e auxílio-moradia</a>
</li>
<li>
<a href="http://www2.camara.leg.br/transparencia/licitacoes-e-contratos">Licitações e contratos</a>
</li>
<li>
<a href="http://www2.camara.leg.br/transparencia/recursos-humanos">Recursos humanos e concursos</a>
</li>
<li>
<a href="http://www2.camara.leg.br/transparencia/receitas-e-despesas">Receitas e despesas</a>
</li>
<li>
<a href="http://www2.camara.leg.br/transparencia/dados-abertos">Dados abertos</a>
</li>
</ul>
</li>
<li aria-haspopup="true" role="menuitem" class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" aria-label="Comunicação">
Comunicação
</a>
<ul class="submenu dropdown-menu" role="menu" aria-hidden="true">
<li>
<a href="http://www2.camara.leg.br/comunicacao/camara-noticias">Câmara Notícias</a>
</li>
<li>
<a href="http://www2.camara.leg.br/comunicacao/tv-camara">TV Câmara</a>
</li>
<li>
<a href="http://www2.camara.leg.br/comunicacao/radio-camara">Rádio Câmara</a>
</li>
<li>
<a href="http://www2.camara.leg.br/comunicacao/assessoria-de-imprensa">Assessoria de Imprensa</a>
</li>
<li>
<a href="http://www2.camara.leg.br/comunicacao/banco-de-imagens">Banco de Imagens</a>
</li>
<li>
<a href="http://www2.camara.leg.br/comunicacao/rede-legislativa-radio-tv">Rede Legislativa de Rádio e TV</a>
</li>
<li>
<a href="http://www2.camara.leg.br/comunicacao/jornal-da-camara">Jornal da Câmara</a>
</li>
<li>
<a href="http://www2.camara.leg.br/comunicacao/Plenarinho">Plenarinho</a>
</li>
</ul>
</li>
<li aria-haspopup="true" role="menuitem" class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" aria-label="Participação">
Participação
</a>
<ul class="submenu dropdown-menu" role="menu" aria-hidden="true">
<li>
<a href="http://www2.camara.leg.br/participacao/saiba-como-participar">Saiba como participar</a>
</li>
<li>
<a href="http://www2.camara.leg.br/participacao/participe-dos-debates">Participe dos debates</a>
</li>
<li>
<a href="http://www2.camara.leg.br/participacao/sugira-um-projeto">Sugira um projeto</a>
</li>
<li>
<a href="http://www2.camara.leg.br/participacao/ajude-a-escrever-a-lei">Ajude a escrever a lei</a>
</li>
<li>
<a href="http://www2.camara.leg.br/participacao/fale-conosco">Fale Conosco</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
</div>
</div>
<div class="container breadcrumbs-marcacao">
<div id="portal-breadcrumbs">
<ol class="breadcrumb">
<li><a href="http://www2.camara.leg.br">Página Inicial</a></li>
<li><a href="http://www2.camara.gov.br/transparencia">Transparência</a></li>
<li><a href="http://www2.camara.gov.br/transparencia/recursos-humanos">Recursos Humanos</a></li>
<li class="active">Remuneração de Servidores</li>
</ol>
</div>
<div class="row">
<div id="menu-secoes-internas" class="col-md-12 menu-secoes-internas">
<div id="portal-mainsection">
<h2 id="areaTituloMenu">
<a href="/transpnet/consulta">
Remuneração dos Servidores da Câmara dos Deputados
</a>
</h2>
</div>
</div>
</div>
</div>
</div>
<div id="marcacao-conteudo-portal" class="conteudo-portal container nopadding-right nopadding-left">
<div class="coluna-centro col-md-12">
<div id="content">
<h3>LUCAS DE CASTRO SANTOS</h3>
<fieldset>
<legend>
<span id="2016100511_hide" style="display:block;"><a onclick="hideRemuneracaoFolha('2016100511');"><span class="glyphicon glyphicon-minus"></span></a> Out/2016 - FOLHA NORMAL</span>
<span id="2016100511_show" style="display:none;"><a onclick="showRemuneracaoFolha('2016100511');"><span class="glyphicon glyphicon-plus"></span></a> Out/2016 - FOLHA NORMAL</span>
</legend>
<div id="2016100511" style="display:block;">
<div>
<table class="table" style="width:100%" summary="Dados do Servidor">
<tr>
<td>
<strong>Vínculo:</strong><br/>PARLAMENTAR
</td>
<td>
<strong>
Data de exercício:
</strong><br/>
</td>
<td>
<strong>Cargo:</strong><br/>DEPUTADO
</td>
<td>
</td>
</tr>
</table>
</div>
<table class="table table-condensed table-striped" style="width:100%" summary="Remunerações">
<caption class="headSessao-1">Mês/Ano de Referência/Tipo Folha: <span>Out/2016 - FOLHA NORMAL</span></caption>
<thead>
<tr>
<th colspan="3">Descrição</th>
<th>Valor R$</th>
</tr>
</thead>
<tbody class="coresAlternadas">
<tr>
<td colspan="4"><strong><span>1 - Remuneração Básica</span></strong></td>
</tr>
<tr>
<td colspan="3">a - Remuneração Fixa</td>
<td class="numerico">33763.0</td>
</tr>
<tr>
<td colspan="3">b - Vantagens de Natureza Pessoal</td>
<td class="numerico">0.0</td>
</tr>
<tr>
<td colspan="4"><strong><span>2 - Remuneração Eventual/Provisória</span></strong></td>
</tr>
<tr>
<td colspan="3">a - Função ou Cargo em Comissão</td>
<td class="numerico">0.0</td>
</tr>
<tr>
<td colspan="3">b - Gratificação Natalina</td>
<td class="numerico">0.0</td>
</tr>
<tr>
<td colspan="3">c - Férias (1/3 Constitucional)</td>
<td class="numerico">0.0</td>
</tr>
<tr>
<td colspan="3">d - Outras Remunerações Eventuais/Provisórias(*)</td>
<td class="numerico">0.0</td>
</tr>
<tr>
<td colspan="4"><strong><span>3 - Abono Permanência</span></strong></td>
</tr>
<tr>
<td colspan="3">a - Abono Permanência</td>
<td class="numerico">0.0</td>
</tr>
<tr>
<td colspan="4"><strong><span>4 - Descontos Obrigatórios(-)</span></strong></td>
</tr>
<tr>
<td colspan="3">a - Redutor Constitucional</td>
<td class="numerico">0.0</td>
</tr>
<tr>
<td colspan="3">b - Contribuição Previdenciária</td>
<td class="numerico">-570.88</td>
</tr>
<tr>
<td colspan="3">c - Imposto de Renda</td>
<td class="numerico">-8258.47</td>
</tr>
<tr>
<td colspan="4"><span><strong>5 - Remuneração após Descontos Obrigatórios</strong></span></td>
</tr>
<tr">
<td colspan="3">a - Remuneração após Descontos Obrigatórios</td>
<td class="numerico">24933.65</td>
</tr>
<tr>
<td colspan="4"><strong><span>6 - Outros</span></strong></td>
</tr>
<tr>
<td colspan="3">a - Diárias</td>
<td class="numerico">0.0</td>
</tr>
<tr>
<td colspan="3">b - Auxílios</td>
<td class="numerico">0.0</td>
</tr>
<tr>
<td colspan="3">c - Vantagens Indenizatórias</td>
<td class="numerico">0.0</td>
</tr>
</tbody>
</table>
</div>
</fieldset>
<hr/>
<div class="page-header">
<p>(*) item pode ter resultado negativo em razão de acertos de meses anteriores e/ou descontos de falta e impontualidade.</p>
<p><strong>Atenção:</strong> os valores líquidos efetivamente recebidos pelo servidor na folha indicada acima podem ser inferiores aos ora divulgados, por não estarem aqui demonstrados os descontos de natureza pessoal (pensão alimentícia, consignações diversas e outros descontos por determinação judicial), que, por sua natureza, não podem ser divulgados.</p>
<p>
<a href="http://www2.camara.leg.br/transparencia/recursos-humanos/quadro-remuneratorio/arquivos/esclarecimentos-consulta-remuneracao">Esclarecimentos acerca dos itens que compõem a remuneração informada</a>
</p>
</div>
<div>
<a href="/transpnet/consulta">Nova Consulta</a>
</div>
</div>
</div>
</div>
<div id="personal-tools-mark" class="hidden-xs hidden-sm">
<div id="userActions-mark"></div>
</div><div id="portal-rodape" class="diazo_layouts_rodape home-Rodape home-Rodape-marcacao">
<div class="conteudo-fluido endereco-rodape">
<div id="portal-footer" class="container">
<div class="row">
<div class="font-bold legislatura-rodape col-md-12">55ª Legislatura - 3ª Sessão Legislativa Ordinária</div>
<div class="col-md-12"><span class="font-bold">Telefone:</span> +55 (61) 3216-0000 | <span class="font-bold">Disque-Câmara: </span>0800-619-619</div>
<div class="col-md-12">Câmara dos Deputados - Palácio do Congresso Nacional - Praça dos Três Poderes - Brasília - DF - Brasil
- CEP 70160-900</div>
<div class="col-md-12"><span class="font-bold">CNPJ:</span> 00.530.352/0001-59 | Horário de atendimento ao público: 9h às 19h</div>
</div>
</div>
</div>
<div class="conteudo-fluido links-sobre-rodape">
<div class="container">
<div id="portal-utilities" class="row">
<div class="col-md-10 col-md-offset-1">
<ul>
<li class="">
<a href="http://www2.camara.leg.br/participe/fale-conosco/perguntas-frequentes">Perguntas Frequentes</a>
</li>
<li class="">
<a href="http://www2.camara.leg.br/accessibility-info">Acessibilidade</a>
</li>
<li class="">
<a href="http://www2.camara.leg.br/english">English</a>
</li>
<li class="">
<a href="http://www2.camara.leg.br/espanol">Español</a>
</li>
<li class="">
<a href="https://camaranet.camara.gov.br">Extranet</a>
</li>
<li class="">
<a accesskey="9" href="http://camara.custhelp.com/">Fale Conosco</a>
</li>
<li class="">
<a href="http://www2.camara.leg.br/glossario">Glossário</a>
</li>
<li class="">
<a href="http://www2.camara.leg.br/transparencia/sispush">Boletins eletrônicos</a>
</li>
<li class="ultimo">
<a href="http://www2.camara.leg.br/sobre-o-portal">Sobre o Portal</a>
</li>
</ul>
</div>
<div class="col-md-1">
<div class="acesso-provedor"><a title="Autenticar-se no site" href="login_form"><span class="glyphicon glyphicon-lock" aria-hidden="true"></span></a></div>
</div>
</div>
</div>
</div>
<div class="barra-carregando" style="display: none">
<h1>Carregando...</h1>
<div class="progress">
<div class="progress-bar progress-bar-striped active" role="progressbar" aria-valuenow="45" aria-valuemin="0" aria-valuemax="100" style="width: 100%">
<span class="sr-only"></span>
</div>
</div>
</div>
</div>
</body>
</html> |
<!DOCTYPE html>
<!-- saved from url=(0074)http://selab.hanyang.ac.kr/courses/cse326/2017/labs/labResources/maze.html -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Maze!</title>
<!-- provided files; do not modify -->
<link href="./Maze_files/maze.css" type="text/css" rel="stylesheet">
<script src="./Maze_files/prototype.js" type="text/javascript"></script>
<!-- your JavaScript -->
<script src="./Maze_files/maze.js" type="text/javascript"></script>
</head>
<body>
<h1>The Amazing Mouse Maze!</h1>
<h2 id="status">Click the "S" to begin.</h2>
<!-- Maze representation -->
<div id="maze">
<div id="start">S</div>
<div class="boundary" id="boundary1"></div>
<div class="boundary"></div>
<div class="boundary"></div>
<div class="boundary"></div>
<div class="boundary"></div>
<div id="end">E</div>
</div>
<p>
The object of this game is to guide the mouse cursor through the start area and get to the end area. Be sure to avoid the walls:
</p>
<div class="boundary example"></div>
<p>
Good luck!
</p>
</body>
</html> |
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="pt">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<link href="https://fonts.googleapis.com/css?family=IBM+Plex+Mono|IBM+Plex+Sans|IBM+Plex+Sans+Condensed|IBM+Plex+Serif" rel="stylesheet">
<script>
/* Define digital data object based on _appInfo object */
window.digitalData = {
page: {
pageInfo: {
productTitle: 'IBM Q Experience',
analytics: {
category: 'Qiskit.org',
},
},
},
};
window._analytics = {
segment_key: 'ffdYLviQze3kzomaINXNk6NwpY9LlXcw',
coremetrics: false,
optimizely: false,
googleAddServices: false,
fullStory: false,
autoPageEventSpa: true,
autoFormEvents: false,
autoPageView: true,
preventPageEvent: true,
};
</script>
<script src="https://cloud.ibm.com/analytics/build/bluemix-analytics.min.js"></script>
<title>qiskit.providers.basicaer.exceptions — Documentação Qiskit 0.12.1</title>
<link rel="stylesheet" href="../../../../_static/material-icons.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/sphinx_tabs/semantic-ui-2.4.1/segment.min.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/sphinx_tabs/semantic-ui-2.4.1/menu.min.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/sphinx_tabs/semantic-ui-2.4.1/tab.min.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/sphinx_tabs/tabs.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/material-design-lite-1.3.0/material.blue-indigo.min.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/sphinx_materialdesign_theme.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/language_data.js"></script>
<script type="text/javascript" src="../../../../_static/sphinx_tabs/semantic-ui-2.4.1/tab.min.js"></script>
<script type="text/javascript" src="../../../../_static/sphinx_tabs/tabs.js"></script>
<script type="text/javascript" src="../../../../_static/js/themeExt.js"></script>
<script type="text/javascript" src="../../../../_static/translations.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="shortcut icon" href="../../../../_static/favicon.ico"/>
<link rel="index" title="Índice" href="../../../../genindex.html" />
<link rel="search" title="Pesquisar" href="../../../../search.html" />
</head>
<body>
<header>
<div class="toolbar limited-width">
<a href="/" class="home">Qiskit</a>
<nav class="first">
<a href="/terra">Terra</a>
<a href="/aer">Aer</a>
<a href="/aqua">Aqua</a>
<a href="/ignis">Ignis</a>
<a href="/ibmqaccount">IBM Q Account</a>
</nav>
<nav class="second">
<a class="external" id="educationLink" href="https://community.qiskit.org/education">Community</a>
<a class="external" id="tutorialsLink" href="https://quantum-computing.ibm.com/jupyter/tutorial/1_start_here.ipynb" target="_blank">Tutorials</a>
<a class="external" href="/documentation" selected>API Documentation</a>
</nav>
</div>
</header>
<div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer"><header class="mdl-layout__drawer">
<!-- Title -->
<span class="mdl-layout-title">
<a class="title" href="../../../../index.html">
<span class="title-text">
Qiskit
</span>
</a>
</span>
<div class="languages" >
<span>Select a language: </span>
<span>
<select id="language" name="languages">
<option value="en">English</option>
<option value="ja">Japanese</option>
</select>
</span>
</div>
<div id="searchbox" role="search">
<div class="searchformwrapper">
<form class="search-form" action="../../../../search.html" method="get">
<input type="text" name="q" class="search-input" placeholder="Search docs..."/>
<button type="submit" class="search-button">
<svg height="20" width="20" fill="#6F6F6F" viewBox="0 0 32 32" class="search-button-icon">
<title>search</title>
<g>
<path d="M30 28.586l-7.552-7.552a11.018 11.018 0 1 0-1.414 1.414L28.586 30zM5 14a9 9 0 1 1 9 9 9.01 9.01 0 0 1-9-9z"></path>
</g>
</svg>
</button>
</form>
</div>
</div>
<div class="globaltoc">
<span class="mdl-layout-title toc">Table Of Contents</span>
<!-- Local TOC -->
<nav class="mdl-navigation"></nav>
</div>
</header>
<main class="mdl-layout__content" tabIndex="0">
<header class="mdl-layout__drawer">
<!-- Title -->
<span class="mdl-layout-title">
<a class="title" href="../../../../index.html">
<span class="title-text">
Qiskit
</span>
</a>
</span>
<div class="languages" >
<span>Select a language: </span>
<span>
<select id="language" name="languages">
<option value="en">English</option>
<option value="ja">Japanese</option>
</select>
</span>
</div>
<div id="searchbox" role="search">
<div class="searchformwrapper">
<form class="search-form" action="../../../../search.html" method="get">
<input type="text" name="q" class="search-input" placeholder="Search docs..."/>
<button type="submit" class="search-button">
<svg height="20" width="20" fill="#6F6F6F" viewBox="0 0 32 32" class="search-button-icon">
<title>search</title>
<g>
<path d="M30 28.586l-7.552-7.552a11.018 11.018 0 1 0-1.414 1.414L28.586 30zM5 14a9 9 0 1 1 9 9 9.01 9.01 0 0 1-9-9z"></path>
</g>
</svg>
</button>
</form>
</div>
</div>
<div class="globaltoc">
<span class="mdl-layout-title toc">Table Of Contents</span>
<!-- Local TOC -->
<nav class="mdl-navigation"></nav>
</div>
</header>
<div class="document">
<div class="page-content">
<h1>Código fonte de qiskit.providers.basicaer.exceptions</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># This code is part of Qiskit.</span>
<span class="c1">#</span>
<span class="c1"># (C) Copyright IBM 2017.</span>
<span class="c1">#</span>
<span class="c1"># This code is licensed under the Apache License, Version 2.0. You may</span>
<span class="c1"># obtain a copy of this license in the LICENSE.txt file in the root directory</span>
<span class="c1"># of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.</span>
<span class="c1">#</span>
<span class="c1"># Any modifications or derivative works of this code must retain this</span>
<span class="c1"># copyright notice, and modified files need to carry a notice indicating</span>
<span class="c1"># that they have been altered from the originals.</span>
<span class="sd">"""</span>
<span class="sd">Exception for errors raised by Basic Aer.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">qiskit.exceptions</span> <span class="k">import</span> <span class="n">QiskitError</span>
<div class="viewcode-block" id="BasicAerError"><a class="viewcode-back" href="../../../../api/qiskit.providers.basicaer.BasicAerError.html#qiskit.providers.basicaer.BasicAerError">[documentos]</a><span class="k">class</span> <span class="nc">BasicAerError</span><span class="p">(</span><span class="n">QiskitError</span><span class="p">):</span>
<span class="sd">"""Base class for errors raised by Basic Aer."""</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">message</span><span class="p">):</span>
<span class="sd">"""Set the error message."""</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">message</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="s1">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return the message."""</span>
<span class="k">return</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">message</span><span class="p">)</span></div>
</pre></div>
</div>
<div class="clearer"></div>
</div><div class="pagenation">
</main>
</div>
<script>
function trackClickEvent (data) {
if (window.bluemixAnalytics && window.digitalData) {
var segmentEvent = {
productTitle: window.digitalData.page.pageInfo.productTitle,
category: window.digitalData.page.pageInfo.analytics.category,
url: window.location.href,
action: window.location.href + ' - Clicked: ' + data.action,
objectType: data.objectType,
successFlag: true
};
if(data.milestoneName) {
segmentEvent = Object.assign(segmentEvent, { milestoneName: data.milestoneName });
}
window.bluemixAnalytics.trackEvent('Custom Event', segmentEvent);
}
};
function clickExternalLink() {
trackClickEvent({
action: "Tutorials Link in Navbar",
objectType: "Link",
milestoneName: "Looked at tutorials"
});
};
var link = document.getElementById('tutorialsLink');
link.addEventListener('click', clickExternalLink);
</script>
<script>
var localeRegExp = /\/(locale\/([a-z-]+)\/)?/i;
var prefix = '/documentation';
function getDefaultLanguage() {
return 'en';
}
var el = document.getElementById('language');
var optionsToSelect = ['en', 'ja']
function changeLoc(evt) {
var language = evt.target.options[el.selectedIndex].value;
var pathname = window.location.pathname.slice(prefix.length);
if (language === getDefaultLanguage()) {
window.location.pathname =
`${prefix}${pathname.replace(localeRegExp, '/')}`;
} else {
window.location.pathname =
`${prefix}${pathname.replace(localeRegExp, `/locale/${language}/`)}`;
}
};
el.addEventListener('change', changeLoc);
function extractLanguageFromUrl(pathname) {
const match = pathname.slice(prefix.length).match(localeRegExp);
return typeof match[2] === 'undefined' ?
getDefaultLanguage() : match[2];
}
function changeSelect(select) {
const optionToSelect = extractLanguageFromUrl(window.location.pathname);
for (var i = 0; i < select.options.length; i++) {
var o = select.options[i];
if (optionToSelect == o.value) {
o.selected = true;
}
}
};
changeSelect(el);
</script>
</body>
</html> |
<!DOCTYPE html>
<html lang="en" dir="ltr" class="client-nojs">
<head>
<title>std::is_signed - cppreference.com</title>
<meta charset="UTF-8">
<meta name="generator" content="MediaWiki 1.21.2">
<link rel="shortcut icon" href="../../../common/favicon.ico">
<link rel="stylesheet" href="../../../common/ext.css">
<meta name="ResourceLoaderDynamicStyles" content="">
<link rel="stylesheet" href="../../../common/site_modules.css">
<style>a:lang(ar),a:lang(ckb),a:lang(fa),a:lang(kk-arab),a:lang(mzn),a:lang(ps),a:lang(ur){text-decoration:none}#toc{display:none}.editsection{display:none}
/* cache key: mwiki1-mwiki_en_:resourceloader:filter:minify-css:7:472787eddcf4605d11de8c7ef047234f */</style>
<script src="../../../common/startup_scripts.js"></script>
<script>if(window.mw){
mw.config.set({"wgCanonicalNamespace":"","wgCanonicalSpecialPageName":false,"wgNamespaceNumber":0,"wgPageName":"cpp/types/is_signed","wgTitle":"cpp/types/is signed","wgCurRevisionId":90997,"wgArticleId":3185,"wgIsArticle":true,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":[],"wgBreakFrames":false,"wgPageContentLanguage":"en","wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy","wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgMonthNamesShort":["","Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],"wgRelevantPageName":"cpp/types/is_signed","wgRestrictionEdit":[],"wgRestrictionMove":[]});
}</script><script>if(window.mw){
mw.loader.implement("user.options",function(){mw.user.options.set({"ccmeonemails":0,"cols":80,"date":"default","diffonly":0,"disablemail":0,"disablesuggest":0,"editfont":"default","editondblclick":0,"editsection":0,"editsectiononrightclick":0,"enotifminoredits":0,"enotifrevealaddr":0,"enotifusertalkpages":1,"enotifwatchlistpages":0,"extendwatchlist":0,"externaldiff":0,"externaleditor":0,"fancysig":0,"forceeditsummary":0,"gender":"unknown","hideminor":0,"hidepatrolled":0,"imagesize":2,"justify":0,"math":1,"minordefault":0,"newpageshidepatrolled":0,"nocache":0,"noconvertlink":0,"norollbackdiff":0,"numberheadings":0,"previewonfirst":0,"previewontop":1,"quickbar":5,"rcdays":7,"rclimit":50,"rememberpassword":0,"rows":25,"searchlimit":20,"showhiddencats":0,"showjumplinks":1,"shownumberswatching":1,"showtoc":0,"showtoolbar":1,"skin":"cppreference2","stubthreshold":0,"thumbsize":2,"underline":2,"uselivepreview":0,"usenewrc":0,"watchcreations":0,"watchdefault":0,"watchdeletion":0,
"watchlistdays":3,"watchlisthideanons":0,"watchlisthidebots":0,"watchlisthideliu":0,"watchlisthideminor":0,"watchlisthideown":0,"watchlisthidepatrolled":0,"watchmoves":0,"wllimit":250,"variant":"en","language":"en","searchNs0":true,"searchNs1":false,"searchNs2":false,"searchNs3":false,"searchNs4":false,"searchNs5":false,"searchNs6":false,"searchNs7":false,"searchNs8":false,"searchNs9":false,"searchNs10":false,"searchNs11":false,"searchNs12":false,"searchNs13":false,"searchNs14":false,"searchNs15":false,"gadget-ColiruCompiler":1,"gadget-MathJax":1});;},{},{});mw.loader.implement("user.tokens",function(){mw.user.tokens.set({"editToken":"+\\","patrolToken":false,"watchToken":false});;},{},{});
/* cache key: mwiki1-mwiki_en_:resourceloader:filter:minify-js:7:9f05c6caceb9bb1a482b6cebd4c5a330 */
}</script>
<script>if(window.mw){
mw.loader.load(["mediawiki.page.startup","mediawiki.legacy.wikibits","mediawiki.legacy.ajax"]);
}</script>
<style type="text/css">/*<![CDATA[*/
.source-cpp {line-height: normal;}
.source-cpp li, .source-cpp pre {
line-height: normal; border: 0px none white;
}
/**
* GeSHi Dynamically Generated Stylesheet
* --------------------------------------
* Dynamically generated stylesheet for cpp
* CSS class: source-cpp, CSS id:
* GeSHi (C) 2004 - 2007 Nigel McNie, 2007 - 2008 Benny Baumann
* (http://qbnz.com/highlighter/ and http://geshi.org/)
* --------------------------------------
*/
.cpp.source-cpp .de1, .cpp.source-cpp .de2 {font: normal normal 1em/1.2em monospace; margin:0; padding:0; background:none; vertical-align:top;}
.cpp.source-cpp {font-family:monospace;}
.cpp.source-cpp .imp {font-weight: bold; color: red;}
.cpp.source-cpp li, .cpp.source-cpp .li1 {font-weight: normal; vertical-align:top;}
.cpp.source-cpp .ln {width:1px;text-align:right;margin:0;padding:0 2px;vertical-align:top;}
.cpp.source-cpp .li2 {font-weight: bold; vertical-align:top;}
.cpp.source-cpp .kw1 {color: #0000dd;}
.cpp.source-cpp .kw2 {color: #0000ff;}
.cpp.source-cpp .kw3 {color: #0000dd;}
.cpp.source-cpp .kw4 {color: #0000ff;}
.cpp.source-cpp .co1 {color: #909090;}
.cpp.source-cpp .co2 {color: #339900;}
.cpp.source-cpp .coMULTI {color: #ff0000; font-style: italic;}
.cpp.source-cpp .es0 {color: #008000; font-weight: bold;}
.cpp.source-cpp .es1 {color: #008000; font-weight: bold;}
.cpp.source-cpp .es2 {color: #008000; font-weight: bold;}
.cpp.source-cpp .es3 {color: #008000; font-weight: bold;}
.cpp.source-cpp .es4 {color: #008000; font-weight: bold;}
.cpp.source-cpp .es5 {color: #008000; font-weight: bold;}
.cpp.source-cpp .br0 {color: #008000;}
.cpp.source-cpp .sy0 {color: #008000;}
.cpp.source-cpp .sy1 {color: #000080;}
.cpp.source-cpp .sy2 {color: #000040;}
.cpp.source-cpp .sy3 {color: #000040;}
.cpp.source-cpp .sy4 {color: #008080;}
.cpp.source-cpp .st0 {color: #008000;}
.cpp.source-cpp .nu0 {color: #000080;}
.cpp.source-cpp .nu6 {color: #000080;}
.cpp.source-cpp .nu8 {color: #000080;}
.cpp.source-cpp .nu12 {color: #000080;}
.cpp.source-cpp .nu16 {color:#000080;}
.cpp.source-cpp .nu17 {color:#000080;}
.cpp.source-cpp .nu18 {color:#000080;}
.cpp.source-cpp .nu19 {color:#000080;}
.cpp.source-cpp .ln-xtra, .cpp.source-cpp li.ln-xtra, .cpp.source-cpp div.ln-xtra {background-color: #ffc;}
.cpp.source-cpp span.xtra { display:block; }
/*]]>*/
</style><style type="text/css">/*<![CDATA[*/
.source-text {line-height: normal;}
.source-text li, .source-text pre {
line-height: normal; border: 0px none white;
}
/**
* GeSHi Dynamically Generated Stylesheet
* --------------------------------------
* Dynamically generated stylesheet for text
* CSS class: source-text, CSS id:
* GeSHi (C) 2004 - 2007 Nigel McNie, 2007 - 2008 Benny Baumann
* (http://qbnz.com/highlighter/ and http://geshi.org/)
* --------------------------------------
*/
.text.source-text .de1, .text.source-text .de2 {font: normal normal 1em/1.2em monospace; margin:0; padding:0; background:none; vertical-align:top;}
.text.source-text {font-family:monospace;}
.text.source-text .imp {font-weight: bold; color: red;}
.text.source-text li, .text.source-text .li1 {font-weight: normal; vertical-align:top;}
.text.source-text .ln {width:1px;text-align:right;margin:0;padding:0 2px;vertical-align:top;}
.text.source-text .li2 {font-weight: bold; vertical-align:top;}
.text.source-text .ln-xtra, .text.source-text li.ln-xtra, .text.source-text div.ln-xtra {background-color: #ffc;}
.text.source-text span.xtra { display:block; }
/*]]>*/
</style><!--[if lt IE 7]><style type="text/css">body{behavior:url("/mwiki/skins/cppreference2/csshover.min.htc")}</style><![endif]--></head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject page-cpp_types_is_signed skin-cppreference2 action-view cpp-navbar">
<!-- header -->
<!-- /header -->
<!-- content -->
<div id="cpp-content-base">
<div id="content">
<a id="top"></a>
<div id="mw-js-message" style="display:none;"></div>
<!-- firstHeading -->
<h1 id="firstHeading" class="firstHeading"><span style="font-size:0.7em; line-height:130%">std::</span>is_signed</h1>
<!-- /firstHeading -->
<!-- bodyContent -->
<div id="bodyContent">
<!-- tagline -->
<div id="siteSub">From cppreference.com</div>
<!-- /tagline -->
<!-- subtitle -->
<div id="contentSub"><span class="subpages">< <a href="../../cpp.html" title="cpp">cpp</a> | <a href="../types.html" title="cpp/types">types</a></span></div>
<!-- /subtitle -->
<!-- bodycontent -->
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr"><div class="t-navbar" style=""><div class="t-navbar-sep"> </div><div class="t-navbar-head"><a href="../../cpp.html" title="cpp"> C++</a><div class="t-navbar-menu"><div><div><table class="t-nv-begin" cellpadding="0" style="line-height:1.1em;">
<tr class="t-nv"><td colspan="5"> <a href="../language.html" title="cpp/language"> Language</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../header.html" title="cpp/header"> Standard Library Headers</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../freestanding.html" title="cpp/freestanding"> Freestanding and hosted implementations</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../named_req.html" title="cpp/named req"> Named requirements </a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../utility.html#Language_support" title="cpp/utility"> Language support library</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../concepts.html" title="cpp/concepts"> Concepts library</a> <span class="t-mark-rev t-since-cxx20">(C++20)</span> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../error.html" title="cpp/error"> Diagnostics library</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../utility.html" title="cpp/utility"> Utilities library</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../string.html" title="cpp/string"> Strings library</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../container.html" title="cpp/container"> Containers library</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../iterator.html" title="cpp/iterator"> Iterators library</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../ranges.html" title="cpp/ranges"> Ranges library</a> <span class="t-mark-rev t-since-cxx20">(C++20)</span> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../algorithm.html" title="cpp/algorithm"> Algorithms library</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../numeric.html" title="cpp/numeric"> Numerics library</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../io.html" title="cpp/io"> Input/output library</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../locale.html" title="cpp/locale"> Localizations library</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../regex.html" title="cpp/regex"> Regular expressions library</a> <span class="t-mark-rev t-since-cxx11">(C++11)</span> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../atomic.html" title="cpp/atomic"> Atomic operations library</a> <span class="t-mark-rev t-since-cxx11">(C++11)</span> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../thread.html" title="cpp/thread"> Thread support library</a> <span class="t-mark-rev t-since-cxx11">(C++11)</span> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../filesystem.html" title="cpp/filesystem"> Filesystem library</a> <span class="t-mark-rev t-since-cxx17">(C++17)</span> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../experimental.html" title="cpp/experimental"> Technical Specifications</a> </td></tr>
</table></div><div></div></div></div></div><div class="t-navbar-sep"> </div><div class="t-navbar-head"><a href="../utility.html" title="cpp/utility"> Utilities library</a><div class="t-navbar-menu"><div><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"> <a href="../types.html" title="cpp/types"> Type support</a> (basic types, RTTI, type traits) </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../memory.html" title="cpp/memory"> Dynamic memory management</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../error.html" title="cpp/error"> Error handling</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../utility/program.html" title="cpp/utility/program"> Program utilities</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../utility/variadic.html" title="cpp/utility/variadic"> Variadic functions</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../utility/feature_test.html" title="cpp/utility/feature test"> Library feature-test macros </a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../chrono.html" title="cpp/chrono"> Date and time</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../utility/functional.html" title="cpp/utility/functional"> Function objects</a> </td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/initializer_list.html" title="cpp/utility/initializer list"><span class="t-lines"><span>initializer_list</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/bitset.html" title="cpp/utility/bitset"><span class="t-lines"><span>bitset</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/hash.html" title="cpp/utility/hash"><span class="t-lines"><span>hash</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/integer_sequence.html" title="cpp/utility/integer sequence"><span class="t-lines"><span>integer_sequence</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx14">(C++14)</span></span></span></div></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Relational operators <span class="t-mark-rev t-deprecated-cxx20">(deprecated in C++20)</span> </td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/rel_ops/operator_cmp.html" title="cpp/utility/rel ops/operator cmp"><span class="t-lines"><span>rel_ops::operator!=</span><span>rel_ops::operator></span><span>rel_ops::operator<=</span><span>rel_ops::operator>=</span></span></a></div></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Comparisons <span class="t-mark-rev t-since-cxx20">(C++20)</span></td></tr>
<tr class="t-nv-col-table"><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/compare/strong_order.html" title="cpp/utility/compare/strong order"><span class="t-lines"><span>strong_order</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/compare/weak_order.html" title="cpp/utility/compare/weak order"><span class="t-lines"><span>weak_order</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/compare/partial_order.html" title="cpp/utility/compare/partial order"><span class="t-lines"><span>partial_order</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"> <br>
</td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/compare/strong_equal.html" title="cpp/utility/compare/strong equal"><span class="t-lines"><span>strong_equal</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/compare/weak_equal.html" title="cpp/utility/compare/weak equal"><span class="t-lines"><span>weak_equal</span></span></a></div></div></td></tr>
</table></div></td><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/compare/strong_ordering.html" title="cpp/utility/compare/strong ordering"><span class="t-lines"><span>strong_ordering</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/compare/weak_ordering.html" title="cpp/utility/compare/weak ordering"><span class="t-lines"><span>weak_ordering</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/compare/partial_ordering.html" title="cpp/utility/compare/partial ordering"><span class="t-lines"><span>partial_ordering</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"> <br>
</td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/compare/strong_equality.html" title="cpp/utility/compare/strong equality"><span class="t-lines"><span>strong_equality</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/compare/weak_equality.html" title="cpp/utility/compare/weak equality"><span class="t-lines"><span>weak_equality</span></span></a></div></div></td></tr>
</table></div></td><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/compare/named_comparison_functions.html" title="cpp/utility/compare/named comparison functions"><span class="t-lines"><span>is_eq</span><span>is_neq</span><span>is_lt</span><span>is_lteq</span><span>is_gt</span><span>is_gteq</span></span></a></div></div></td></tr>
</table></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/compare/common_comparison_category.html" title="cpp/utility/compare/common comparison category"><span class="t-lines"><span>common_comparison_category</span></span></a></div></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Common vocabulary types </td></tr>
<tr class="t-nv-col-table"><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/pair.html" title="cpp/utility/pair"><span class="t-lines"><span>pair</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/tuple.html" title="cpp/utility/tuple"><span class="t-lines"><span>tuple</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/apply.html" title="cpp/utility/apply"><span class="t-lines"><span>apply</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/make_from_tuple.html" title="cpp/utility/make from tuple"><span class="t-lines"><span>make_from_tuple</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
</table></div></td><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/optional.html" title="cpp/utility/optional"><span class="t-lines"><span>optional</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/any.html" title="cpp/utility/any"><span class="t-lines"><span>any</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/variant.html" title="cpp/utility/variant"><span class="t-lines"><span>variant</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"> <br>
</td></tr>
</table></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Swap, forward and move</td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../algorithm/swap.html" title="cpp/algorithm/swap"><span class="t-lines"><span>swap</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/exchange.html" title="cpp/utility/exchange"><span class="t-lines"><span>exchange</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx14">(C++14)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/forward.html" title="cpp/utility/forward"><span class="t-lines"><span>forward</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/move.html" title="cpp/utility/move"><span class="t-lines"><span>move</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/move_if_noexcept.html" title="cpp/utility/move if noexcept"><span class="t-lines"><span>move_if_noexcept</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Elementary string conversions</td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/to_chars.html" title="cpp/utility/to chars"><span class="t-lines"><span>to_chars</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/from_chars.html" title="cpp/utility/from chars"><span class="t-lines"><span>from_chars</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/chars_format.html" title="cpp/utility/chars format"><span class="t-lines"><span>chars_format</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Type operations</td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/declval.html" title="cpp/utility/declval"><span class="t-lines"><span>declval</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/as_const.html" title="cpp/utility/as const"><span class="t-lines"><span>as_const</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="../utility/launder.html" title="cpp/utility/launder"><span class="t-lines"><span>launder</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
</table></div><div></div></div></div></div><div class="t-navbar-sep"> </div><div class="t-navbar-head"><a href="../types.html" title="cpp/types"> Type support</a><div class="t-navbar-menu"><div><div style="display:inline-block; vertical-align: top;">
<div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv-h1"><td colspan="5"> Basic types</td></tr>
<tr class="t-nv"><td colspan="5"> <a href="../language/types.html" title="cpp/language/types"> Fundamental types</a> </td></tr>
<tr class="t-nv"><td colspan="5"> <a href="integer.html" title="cpp/types/integer"> Fixed width integer types</a> <span class="t-mark-rev t-since-cxx11">(C++11)</span></td></tr>
<tr class="t-nv-col-table"><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="ptrdiff_t.html" title="cpp/types/ptrdiff t"><span class="t-lines"><span>ptrdiff_t</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="size_t.html" title="cpp/types/size t"><span class="t-lines"><span>size_t</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="max_align_t.html" title="cpp/types/max align t"><span class="t-lines"><span>max_align_t</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="byte.html" title="cpp/types/byte"><span class="t-lines"><span>byte</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
</table></div></td><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="nullptr_t.html" title="cpp/types/nullptr t"><span class="t-lines"><span>nullptr_t</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="offsetof.html" title="cpp/types/offsetof"><span class="t-lines"><span>offsetof</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="NULL.html" title="cpp/types/NULL"><span class="t-lines"><span>NULL</span></span></a></div></div></td></tr>
</table></div></td></tr>
<tr class="t-nv-h1"><td colspan="5"> Numeric limits</td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="numeric_limits.html" title="cpp/types/numeric limits"><span class="t-lines"><span>numeric_limits</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"> <a href="climits.html" title="cpp/types/climits">C numeric limits interface</a></td></tr>
<tr class="t-nv-h1"><td colspan="5"> Runtime type information</td></tr>
<tr class="t-nv-col-table"><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="type_info.html" title="cpp/types/type info"><span class="t-lines"><span>type_info</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="type_index.html" title="cpp/types/type index"><span class="t-lines"><span>type_index</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
</table></div></td><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="bad_typeid.html" title="cpp/types/bad typeid"><span class="t-lines"><span>bad_typeid</span></span></a></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="bad_cast.html" title="cpp/types/bad cast"><span class="t-lines"><span>bad_cast</span></span></a></div></div></td></tr>
</table></div></td></tr>
<tr class="t-nv-h1"><td colspan="5"> Type traits</td></tr>
<tr class="t-nv-h2"><td colspan="5"> Type categories</td></tr>
<tr class="t-nv-col-table"><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_void.html" title="cpp/types/is void"><span class="t-lines"><span>is_void</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_null_pointer.html" title="cpp/types/is null pointer"><span class="t-lines"><span>is_null_pointer</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx14">(C++14)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_array.html" title="cpp/types/is array"><span class="t-lines"><span>is_array</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_pointer.html" title="cpp/types/is pointer"><span class="t-lines"><span>is_pointer</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_enum.html" title="cpp/types/is enum"><span class="t-lines"><span>is_enum</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_union.html" title="cpp/types/is union"><span class="t-lines"><span>is_union</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_class.html" title="cpp/types/is class"><span class="t-lines"><span>is_class</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_function.html" title="cpp/types/is function"><span class="t-lines"><span>is_function</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
</table></div></td><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_object.html" title="cpp/types/is object"><span class="t-lines"><span>is_object</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_scalar.html" title="cpp/types/is scalar"><span class="t-lines"><span>is_scalar</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_compound.html" title="cpp/types/is compound"><span class="t-lines"><span>is_compound</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_integral.html" title="cpp/types/is integral"><span class="t-lines"><span>is_integral</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_floating_point.html" title="cpp/types/is floating point"><span class="t-lines"><span>is_floating_point</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_fundamental.html" title="cpp/types/is fundamental"><span class="t-lines"><span>is_fundamental</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_arithmetic.html" title="cpp/types/is arithmetic"><span class="t-lines"><span>is_arithmetic</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
</table></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_reference.html" title="cpp/types/is reference"><span class="t-lines"><span>is_reference</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_lvalue_reference.html" title="cpp/types/is lvalue reference"><span class="t-lines"><span>is_lvalue_reference</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_rvalue_reference.html" title="cpp/types/is rvalue reference"><span class="t-lines"><span>is_rvalue_reference</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_member_pointer.html" title="cpp/types/is member pointer"><span class="t-lines"><span>is_member_pointer</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_member_object_pointer.html" title="cpp/types/is member object pointer"><span class="t-lines"><span>is_member_object_pointer</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_member_function_pointer.html" title="cpp/types/is member function pointer"><span class="t-lines"><span>is_member_function_pointer</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
</table></div>
<div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv-h2"><td colspan="5"> Type properties</td></tr>
<tr class="t-nv-col-table"><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_const.html" title="cpp/types/is const"><span class="t-lines"><span>is_const</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_volatile.html" title="cpp/types/is volatile"><span class="t-lines"><span>is_volatile</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_empty.html" title="cpp/types/is empty"><span class="t-lines"><span>is_empty</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_polymorphic.html" title="cpp/types/is polymorphic"><span class="t-lines"><span>is_polymorphic</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_final.html" title="cpp/types/is final"><span class="t-lines"><span>is_final</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx14">(C++14)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_abstract.html" title="cpp/types/is abstract"><span class="t-lines"><span>is_abstract</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_aggregate.html" title="cpp/types/is aggregate"><span class="t-lines"><span>is_aggregate</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_trivial.html" title="cpp/types/is trivial"><span class="t-lines"><span>is_trivial</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
</table></div></td><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_trivially_copyable.html" title="cpp/types/is trivially copyable"><span class="t-lines"><span>is_trivially_copyable</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_standard_layout.html" title="cpp/types/is standard layout"><span class="t-lines"><span>is_standard_layout</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_literal_type.html" title="cpp/types/is literal type"><span class="t-lines"><span>is_literal_type</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span><span class="t-mark-rev t-until-cxx20">(until C++20)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_pod.html" title="cpp/types/is pod"><span class="t-lines"><span>is_pod</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span><span class="t-mark-rev t-deprecated-cxx20">(deprecated in C++20)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><strong class="selflink"><span class="t-lines"><span>is_signed</span></span></strong></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_unsigned.html" title="cpp/types/is unsigned"><span class="t-lines"><span>is_unsigned</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_bounded_array.html" title="cpp/types/is bounded array"><span class="t-lines"><span>is_bounded_array</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_unbounded_array.html" title="cpp/types/is unbounded array"><span class="t-lines"><span>is_unbounded_array</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div></div></td></tr>
</table></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="has_unique_object_representations.html" title="cpp/types/has unique object representations"><span class="t-lines"><span>has_unique_object_representations</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Type trait constants</td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="integral_constant.html" title="cpp/types/integral constant"><span class="t-lines"><span>integral_constant</span><span>bool_constant</span><span>true_type</span><span>false_type</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Metafunctions</td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="conjunction.html" title="cpp/types/conjunction"><span class="t-lines"><span>conjunction</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="disjunction.html" title="cpp/types/disjunction"><span class="t-lines"><span>disjunction</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="negation.html" title="cpp/types/negation"><span class="t-lines"><span>negation</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Endian</td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="endian.html" title="cpp/types/endian"><span class="t-lines"><span>endian</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Constant evaluation context</td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_constant_evaluated.html" title="cpp/types/is constant evaluated"><span class="t-lines"><span>is_constant_evaluated</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div></div></td></tr>
</table></div>
</div>
<div style="display:inline-block; vertical-align: top;">
<div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv-h2"><td colspan="5"> Supported operations</td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_constructible.html" title="cpp/types/is constructible"><span class="t-lines"><span>is_constructible</span><span>is_trivially_constructible</span><span>is_nothrow_constructible</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_default_constructible.html" title="cpp/types/is default constructible"><span class="t-lines"><span>is_default_constructible</span><span>is_trivially_default_constructible</span><span>is_nothrow_default_constructible</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_copy_constructible.html" title="cpp/types/is copy constructible"><span class="t-lines"><span>is_copy_constructible</span><span>is_trivially_copy_constructible</span><span>is_nothrow_copy_constructible</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_move_constructible.html" title="cpp/types/is move constructible"><span class="t-lines"><span>is_move_constructible</span><span>is_trivially_move_constructible</span><span>is_nothrow_move_constructible</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_assignable.html" title="cpp/types/is assignable"><span class="t-lines"><span>is_assignable</span><span>is_trivially_assignable</span><span>is_nothrow_assignable</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_copy_assignable.html" title="cpp/types/is copy assignable"><span class="t-lines"><span>is_copy_assignable</span><span>is_trivially_copy_assignable</span><span>is_nothrow_copy_assignable</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_move_assignable.html" title="cpp/types/is move assignable"><span class="t-lines"><span>is_move_assignable</span><span>is_trivially_move_assignable</span><span>is_nothrow_move_assignable</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_destructible.html" title="cpp/types/is destructible"><span class="t-lines"><span>is_destructible</span><span>is_trivially_destructible</span><span>is_nothrow_destructible</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="has_virtual_destructor.html" title="cpp/types/has virtual destructor"><span class="t-lines"><span>has_virtual_destructor</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_swappable.html" title="cpp/types/is swappable"><span class="t-lines"><span>is_swappable_with</span><span>is_swappable</span><span>is_nothrow_swappable_with</span><span>is_nothrow_swappable</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Relationships and property queries</td></tr>
<tr class="t-nv-col-table"><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_same.html" title="cpp/types/is same"><span class="t-lines"><span>is_same</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_base_of.html" title="cpp/types/is base of"><span class="t-lines"><span>is_base_of</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_convertible.html" title="cpp/types/is convertible"><span class="t-lines"><span>is_convertible</span><span>is_nothrow_convertible</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div></div></td></tr>
</table></div></td><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="alignment_of.html" title="cpp/types/alignment of"><span class="t-lines"><span>alignment_of</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="rank.html" title="cpp/types/rank"><span class="t-lines"><span>rank</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="extent.html" title="cpp/types/extent"><span class="t-lines"><span>extent</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
</table></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="is_invocable.html" title="cpp/types/is invocable"><span class="t-lines"><span>is_invocable</span><span>is_invocable_r</span><span>is_nothrow_invocable</span><span>is_nothrow_invocable_r</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Type modifications</td></tr>
<tr class="t-nv-col-table"><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="remove_cv.html" title="cpp/types/remove cv"><span class="t-lines"><span>remove_cv</span><span>remove_const</span><span>remove_volatile</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="add_cv.html" title="cpp/types/add cv"><span class="t-lines"><span>add_cv</span><span>add_const</span><span>add_volatile</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="make_signed.html" title="cpp/types/make signed"><span class="t-lines"><span>make_signed</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="make_unsigned.html" title="cpp/types/make unsigned"><span class="t-lines"><span>make_unsigned</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
</table></div></td><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="remove_reference.html" title="cpp/types/remove reference"><span class="t-lines"><span>remove_reference</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="add_reference.html" title="cpp/types/add reference"><span class="t-lines"><span>add_lvalue_reference</span><span>add_rvalue_reference</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="remove_pointer.html" title="cpp/types/remove pointer"><span class="t-lines"><span>remove_pointer</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="add_pointer.html" title="cpp/types/add pointer"><span class="t-lines"><span>add_pointer</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="remove_extent.html" title="cpp/types/remove extent"><span class="t-lines"><span>remove_extent</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="remove_all_extents.html" title="cpp/types/remove all extents"><span class="t-lines"><span>remove_all_extents</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
</table></div></td></tr>
<tr class="t-nv-h2"><td colspan="5"> Type transformations</td></tr>
<tr class="t-nv-col-table"><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="aligned_storage.html" title="cpp/types/aligned storage"><span class="t-lines"><span>aligned_storage</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="aligned_union.html" title="cpp/types/aligned union"><span class="t-lines"><span>aligned_union</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="decay.html" title="cpp/types/decay"><span class="t-lines"><span>decay</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="remove_cvref.html" title="cpp/types/remove cvref"><span class="t-lines"><span>remove_cvref</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="enable_if.html" title="cpp/types/enable if"><span class="t-lines"><span>enable_if</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="void_t.html" title="cpp/types/void t"><span class="t-lines"><span>void_t</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
</table></div></td><td><div><table class="t-nv-begin" cellpadding="0" style="">
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="conditional.html" title="cpp/types/conditional"><span class="t-lines"><span>conditional</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="common_type.html" title="cpp/types/common type"><span class="t-lines"><span>common_type</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="common_reference.html" title="cpp/types/common reference"><span class="t-lines"><span>common_reference</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="underlying_type.html" title="cpp/types/underlying type"><span class="t-lines"><span>underlying_type</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="result_of.html" title="cpp/types/result of"><span class="t-lines"><span>result_of</span><span>invoke_result</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span><span class="t-mark-rev t-until-cxx20">(until C++20)</span></span><span><span class="t-mark-rev t-since-cxx17">(C++17)</span></span></span></div></div></td></tr>
<tr class="t-nv"><td colspan="5"><div class="t-nv-ln-table"><div><a href="type_identity.html" title="cpp/types/type identity"><span class="t-lines"><span>type_identity</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx20">(C++20)</span></span></span></div></div></td></tr>
</table></div></td></tr>
</table></div>
</div><div></div></div></div></div><div class="t-navbar-sep"> </div></div>
<table class="t-dcl-begin"><tbody>
<tr class="t-dsc-header">
<td> <div>Defined in header <code><a href="../header/type_traits.html" title="cpp/header/type traits"><type_traits></a></code>
</div></td>
<td></td>
<td></td>
</tr>
<tr class="t-dcl t-since-cxx11">
<td> <div><span class="mw-geshi cpp source-cpp"><span class="kw1">template</span><span class="sy1"><</span> <span class="kw1">class</span> T <span class="sy1">></span><br>
<span class="kw1">struct</span> is_signed<span class="sy4">;</span></span></div></td>
<td class="t-dcl-nopad"> </td>
<td> <span class="t-mark-rev t-since-cxx11">(since C++11)</span> </td>
</tr>
<tr class="t-dcl-sep"><td></td><td></td><td></td></tr>
</tbody></table>
<p>If <code>T</code> is an arithmetic type, provides the member constant <code>value</code> equal <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="kw2">true</span></span></span> if <code>T(-1) < T(0)</code>: this results in <code>true</code> for the floating-point types and the signed integer types, and in <code>false</code> for the unsigned integer types and the type <code>bool</code>.
</p><p>For any other type, <code>value</code> is <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="kw2">false</span></span></span>.
</p>
<h3><span class="mw-headline" id="Template_parameters">Template parameters</span></h3>
<table class="t-par-begin">
<tr class="t-par">
<td> T
</td>
<td> -
</td>
<td> a type to check
</td></tr></table>
<h3><span class="mw-headline" id="Helper_variable_template"> Helper variable template </span></h3>
<table class="t-dcl-begin"><tbody>
<tr class="t-dcl t-since-cxx17">
<td> <div><span class="mw-geshi cpp source-cpp"><span class="kw1">template</span><span class="sy1"><</span> <span class="kw1">class</span> T <span class="sy1">></span><br>
<span class="kw1">inline</span> <span class="kw4">constexpr</span> <span class="kw4">bool</span> is_signed_v <span class="sy1">=</span> is_signed<span class="sy1"><</span>T<span class="sy1">></span><span class="sy4">::</span><span class="me2">value</span><span class="sy4">;</span></span></div></td>
<td class="t-dcl-nopad"> </td>
<td> <span class="t-mark-rev t-since-cxx17">(since C++17)</span> </td>
</tr>
<tr class="t-dcl-sep"><td></td><td></td><td></td></tr>
</tbody></table>
<div class="t-template-editlink" style="">
</div><div class="t-inherited">
<h2> <span class="mw-headline" id="Inherited_from_std::integral_constant">Inherited from <a href="integral_constant.html" title="cpp/types/integral constant"> <span style="font-size:0.7em; line-height:130%">std::</span>integral_constant</a></span></h2>
<h3> <span class="mw-headline" id="Member_constants">Member constants</span></h3>
<table class="t-dsc-begin">
<tr class="t-dsc">
<td> <div class="t-dsc-member-div"><div><span class="t-lines"><span>value</span></span></div><div><span class="t-lines"><span><span class="t-cmark">[static]</span></span></span></div></div>
</td>
<td> <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="kw2">true</span></span></span> if <code>T</code> is a signed arithmetic type , <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="kw2">false</span></span></span> otherwise <br> <span class="t-mark">(public static member constant)</span>
</td></tr>
</table>
<h3> <span class="mw-headline" id="Member_functions">Member functions</span></h3>
<table class="t-dsc-begin">
<tr class="t-dsc">
<td> <div class="t-dsc-member-div"><div><span class="t-lines"><span>operator bool</span></span></div></div>
</td>
<td> converts the object to <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="kw4">bool</span></span></span>, returns <code>value</code> <br> <span class="t-mark">(public member function)</span>
</td></tr>
<tr class="t-dsc">
<td> <div class="t-dsc-member-div"><div><span class="t-lines"><span>operator()</span></span></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx14">(C++14)</span></span></span></div></div>
</td>
<td> returns <code>value</code> <br> <span class="t-mark">(public member function)</span>
</td></tr>
</table>
<h3> <span class="mw-headline" id="Member_types">Member types</span></h3>
<table class="t-dsc-begin">
<tr class="t-dsc-hitem">
<td> Type
</td>
<td> Definition
</td></tr>
<tr class="t-dsc">
<td> <code>value_type</code>
</td>
<td> <code>bool</code>
</td></tr>
<tr class="t-dsc">
<td> <code>type</code>
</td>
<td> <span class="t-c"><span class="mw-geshi cpp source-cpp"><a href="integral_constant.html"><span class="kw641">std::<span class="me2">integral_constant</span></span></a><span class="sy1"><</span><span class="kw4">bool</span>, value<span class="sy1">></span></span></span>
</td></tr>
</table>
</div>
<h3><span class="mw-headline" id="Possible_implementation">Possible implementation</span></h3>
<table class="eq-fun-cpp-table">
<tr>
<td>
<div dir="ltr" class="mw-geshi" style="text-align: left;"><div class="cpp source-cpp"><pre class="de1"><span class="kw1">namespace</span> detail <span class="br0">{</span>
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">typename</span> T,<span class="kw4">bool</span> <span class="sy1">=</span> <a href="is_arithmetic.html"><span class="kw482">std::<span class="me2">is_arithmetic</span></span></a><span class="sy1"><</span>T<span class="sy1">></span><span class="sy4">::</span><span class="me2">value</span><span class="sy1">></span>
<span class="kw1">struct</span> is_signed <span class="sy4">:</span> <a href="integral_constant.html"><span class="kw641">std::<span class="me2">integral_constant</span></span></a><span class="sy1"><</span><span class="kw4">bool</span>, T<span class="br0">(</span><span class="sy2">-</span><span class="nu0">1</span><span class="br0">)</span> <span class="sy1"><</span> T<span class="br0">(</span><span class="nu0">0</span><span class="br0">)</span><span class="sy1">></span> <span class="br0">{</span><span class="br0">}</span><span class="sy4">;</span>
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">typename</span> T<span class="sy1">></span>
<span class="kw1">struct</span> is_signed<span class="sy1"><</span>T,<span class="kw2">false</span><span class="sy1">></span> <span class="sy4">:</span> <a href="integral_constant.html"><span class="kw644">std::<span class="me2">false_type</span></span></a> <span class="br0">{</span><span class="br0">}</span><span class="sy4">;</span>
<span class="br0">}</span> <span class="co1">// namespace detail</span>
<span class="kw1">template</span><span class="sy1"><</span><span class="kw1">typename</span> T<span class="sy1">></span>
<span class="kw1">struct</span> is_signed <span class="sy4">:</span> detail<span class="sy4">::</span><span class="me2">is_signed</span><span class="sy1"><</span>T<span class="sy1">></span><span class="sy4">::</span><span class="me2">type</span> <span class="br0">{</span><span class="br0">}</span><span class="sy4">;</span></pre></div></div>
</td></tr></table>
<h3><span class="mw-headline" id="Example">Example</span></h3>
<div class="t-example"><div class="t-example-live-link"><div class="coliru-btn coliru-btn-run-init">Run this code</div></div>
<div dir="ltr" class="mw-geshi" style="text-align: left;"><div class="cpp source-cpp"><pre class="de1"><span class="co2">#include <iostream></span>
<span class="co2">#include <type_traits></span>
<span class="kw1">class</span> A <span class="br0">{</span><span class="br0">}</span><span class="sy4">;</span>
<span class="kw2">enum</span> B <span class="sy4">:</span> <span class="kw4">int</span> <span class="br0">{</span><span class="br0">}</span><span class="sy4">;</span>
<span class="kw2">enum</span> <span class="kw1">class</span> C <span class="sy4">:</span> <span class="kw4">int</span> <span class="br0">{</span><span class="br0">}</span><span class="sy4">;</span>
<span class="kw4">int</span> main<span class="br0">(</span><span class="br0">)</span>
<span class="br0">{</span>
<a href="../io/cout.html"><span class="kw1753">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> <a href="../io/manip/boolalpha.html"><span class="kw1759">std::<span class="me2">boolalpha</span></span></a><span class="sy4">;</span>
<a href="../io/cout.html"><span class="kw1753">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> std<span class="sy4">::</span><span class="me2">is_signed</span><span class="sy1"><</span>A<span class="sy1">></span><span class="sy4">::</span><span class="me2">value</span> <span class="sy1"><<</span> <span class="st0">'<span class="es1">\n</span>'</span><span class="sy4">;</span>
<a href="../io/cout.html"><span class="kw1753">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> std<span class="sy4">::</span><span class="me2">is_signed</span><span class="sy1"><</span><span class="kw4">float</span><span class="sy1">></span><span class="sy4">::</span><span class="me2">value</span> <span class="sy1"><<</span> <span class="st0">'<span class="es1">\n</span>'</span><span class="sy4">;</span>
<a href="../io/cout.html"><span class="kw1753">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> std<span class="sy4">::</span><span class="me2">is_signed</span><span class="sy1"><</span><span class="kw4">signed</span> <span class="kw4">int</span><span class="sy1">></span><span class="sy4">::</span><span class="me2">value</span> <span class="sy1"><<</span> <span class="st0">'<span class="es1">\n</span>'</span><span class="sy4">;</span>
<a href="../io/cout.html"><span class="kw1753">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> std<span class="sy4">::</span><span class="me2">is_signed</span><span class="sy1"><</span><span class="kw4">unsigned</span> <span class="kw4">int</span><span class="sy1">></span><span class="sy4">::</span><span class="me2">value</span> <span class="sy1"><<</span> <span class="st0">'<span class="es1">\n</span>'</span><span class="sy4">;</span>
<a href="../io/cout.html"><span class="kw1753">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> std<span class="sy4">::</span><span class="me2">is_signed</span><span class="sy1"><</span>B<span class="sy1">></span><span class="sy4">::</span><span class="me2">value</span> <span class="sy1"><<</span> <span class="st0">'<span class="es1">\n</span>'</span><span class="sy4">;</span>
<a href="../io/cout.html"><span class="kw1753">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> std<span class="sy4">::</span><span class="me2">is_signed</span><span class="sy1"><</span>C<span class="sy1">></span><span class="sy4">::</span><span class="me2">value</span> <span class="sy1"><<</span> <span class="st0">'<span class="es1">\n</span>'</span><span class="sy4">;</span>
<span class="co1">// shorter:</span>
<a href="../io/cout.html"><span class="kw1753">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> std<span class="sy4">::</span><span class="me2">is_signed</span><span class="sy1"><</span><span class="kw4">signed</span> <span class="kw4">int</span><span class="sy1">></span><span class="br0">(</span><span class="br0">)</span> <span class="sy1"><<</span> <span class="st0">'<span class="es1">\n</span>'</span><span class="sy4">;</span>
<a href="../io/cout.html"><span class="kw1753">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> std<span class="sy4">::</span><span class="me2">is_signed</span><span class="sy1"><</span><span class="kw4">unsigned</span> <span class="kw4">int</span><span class="sy1">></span><span class="br0">(</span><span class="br0">)</span> <span class="sy1"><<</span> <span class="st0">'<span class="es1">\n</span>'</span><span class="sy4">;</span>
<span class="br0">}</span></pre></div></div>
<p>Output:
</p>
<div dir="ltr" class="mw-geshi" style="text-align: left;"><div class="text source-text"><pre class="de1">false
true
true
false
false
false
true
false</pre></div></div>
</div>
<h3><span class="mw-headline" id="See_also">See also</span></h3>
<table class="t-dsc-begin">
<tr class="t-dsc">
<td> <div class="t-dsc-member-div"><div><a href="is_unsigned.html" title="cpp/types/is unsigned"> <span class="t-lines"><span>is_unsigned</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div>
</td>
<td> checks if a type is an unsigned arithmetic type <br> <span class="t-mark">(class template)</span> </td></tr>
<tr class="t-dsc">
<td> <div class="t-dsc-member-div"><div><a href="numeric_limits/is_signed.html" title="cpp/types/numeric limits/is signed"> <span class="t-lines"><span>is_signed</span></span></a></div><div><span class="t-lines"><span><span class="t-cmark">[static]</span></span></span></div></div>
</td>
<td> identifies signed types <br> <span class="t-mark">(public static member constant of <code>std::numeric_limits<T></code>)</span> </td></tr>
<tr class="t-dsc">
<td> <div class="t-dsc-member-div"><div><a href="is_arithmetic.html" title="cpp/types/is arithmetic"> <span class="t-lines"><span>is_arithmetic</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div>
</td>
<td> checks if a type is an arithmetic type <br> <span class="t-mark">(class template)</span> </td></tr>
<tr class="t-dsc">
<td> <div class="t-dsc-member-div"><div><a href="make_signed.html" title="cpp/types/make signed"> <span class="t-lines"><span>make_signed</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div>
</td>
<td> makes the given integral type signed <br> <span class="t-mark">(class template)</span> </td></tr>
<tr class="t-dsc">
<td> <div class="t-dsc-member-div"><div><a href="make_unsigned.html" title="cpp/types/make unsigned"> <span class="t-lines"><span>make_unsigned</span></span></a></div><div><span class="t-lines"><span><span class="t-mark-rev t-since-cxx11">(C++11)</span></span></span></div></div>
</td>
<td> makes the given integral type unsigned <br> <span class="t-mark">(class template)</span> </td></tr>
</table>
<!--
NewPP limit report
Preprocessor visited node count: 12431/1000000
Preprocessor generated node count: 14095/1000000
Post‐expand include size: 423085/2097152 bytes
Template argument size: 84843/2097152 bytes
Highest expansion depth: 32/40
Expensive parser function count: 0/100
-->
<!-- Saved in parser cache with key mwiki1-mwiki_en_:pcache:idhash:3185-0!*!0!!en!*!* and timestamp 20190601180337 -->
</div> <!-- /bodycontent -->
<!-- printfooter -->
<div class="printfooter">
Retrieved from "<a href="https://en.cppreference.com/mwiki/index.php?title=cpp/types/is_signed&oldid=90997">https://en.cppreference.com/mwiki/index.php?title=cpp/types/is_signed&oldid=90997</a>" </div>
<!-- /printfooter -->
<!-- catlinks -->
<!-- /catlinks -->
<div class="visualClear"></div>
<!-- debughtml -->
<!-- /debughtml -->
</div>
<!-- /bodyContent -->
</div>
</div>
<!-- /content -->
<!-- footer -->
<!-- /footer -->
<script>if(window.mw){
mw.loader.state({"site":"loading","user":"missing","user.groups":"ready"});
}</script>
<script src="../../../common/skin_scripts.js"></script>
<script>if(window.mw){
mw.loader.load(["mediawiki.action.view.postEdit","mediawiki.user","mediawiki.page.ready","mediawiki.searchSuggest","mediawiki.hidpi","ext.gadget.ColiruCompiler","ext.gadget.MathJax"], null, true);
}</script>
<script src="../../../common/site_scripts.js"></script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-2828341-1']);
_gaq.push(['_setDomainName', 'cppreference.com']);
_gaq.push(['_trackPageview']);
</script><!-- Served in 1.591 secs. -->
</body>
<!-- Cached 20190601180337 -->
</html> |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<script>
//alert("Hop!");
//var x = prompt("?");
//document.write(x);
x = confirm("Tamam mı?");
if (x) {
document.write("Tamam");
}
else {
document.write("Tamam Değil");
}
</script>
</body>
</html> |
<footer class="footer">
<p>© {{site.username}}</p>
<p>Build with Jekyll and Nathan Randecker</p>
</footer>
<script src="//cdn.jsdelivr.net/particles.js/2.0.0/particles.min.js"></script>
<script src="{{ "/assets/js/sweet-scroll.min.js" | prepend: site.baseurl }}"></script>
<script src="{{ "/assets/js/main.js" | prepend: site.baseurl }}"></script>
{% include google-analytics.html %}
|
<html>
<head>
<title>KiiCorp.Cloud.Storage.KiiACLListCallback<T,U></title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<style>
a { text-decoration: none }
div.SideBar {
padding-left: 1em;
padding-right: 1em;
right: 0;
float: right;
border: thin solid black;
background-color: #f2f2f2;
}
.CollectionTitle { font-weight: bold }
.PageTitle { font-size: 150%; font-weight: bold }
.Summary { }
.Signature { }
.Remarks { }
.Members { }
.Copyright { }
.Section { font-size: 125%; font-weight: bold }
p.Summary {
margin-left: 1em;
}
.SectionBox { margin-left: 2em }
.NamespaceName { font-size: 105%; font-weight: bold }
.NamespaceSumary { }
.MemberName { font-size: 115%; font-weight: bold; margin-top: 1em }
.Subsection { font-size: 105%; font-weight: bold }
.SubsectionBox { margin-left: 2em; margin-bottom: 1em }
.CodeExampleTable { background-color: #f5f5dd; border: thin solid black; padding: .25em; }
.TypesListing {
border-collapse: collapse;
}
td {
vertical-align: top;
}
th {
text-align: left;
}
.TypesListing td {
margin: 0px;
padding: .25em;
border: solid gray 1px;
}
.TypesListing th {
margin: 0px;
padding: .25em;
background-color: #f2f2f2;
border: solid gray 1px;
}
div.Footer {
border-top: 1px solid gray;
margin-top: 1.5em;
padding-top: 0.6em;
text-align: center;
color: gray;
}
span.NotEntered /* Documentation for this section has not yet been entered */ {
font-style: italic;
color: red;
}
div.Header {
background: #B0C4DE;
border: double;
border-color: white;
border-width: 7px;
padding: 0.5em;
}
div.Header * {
font-size: smaller;
}
div.Note {
}
i.ParamRef {
}
i.subtitle {
}
ul.TypeMembersIndex {
text-align: left;
background: #F8F8F8;
}
ul.TypeMembersIndex li {
display: inline;
margin: 0.5em;
}
table.HeaderTable {
}
table.SignatureTable {
}
table.Documentation, table.Enumeration, table.TypeDocumentation {
border-collapse: collapse;
width: 100%;
}
table.Documentation tr th, table.TypeMembers tr th, table.Enumeration tr th, table.TypeDocumentation tr th {
background: whitesmoke;
padding: 0.8em;
border: 1px solid gray;
text-align: left;
vertical-align: bottom;
}
table.Documentation tr td, table.TypeMembers tr td, table.Enumeration tr td, table.TypeDocumentation tr td {
padding: 0.5em;
border: 1px solid gray;
text-align: left;
vertical-align: top;
}
table.TypeMembers {
border: 1px solid #C0C0C0;
width: 100%;
}
table.TypeMembers tr td {
background: #F8F8F8;
border: white;
}
table.Documentation {
}
table.TypeMembers {
}
div.CodeExample {
width: 100%;
border: 1px solid #DDDDDD;
background-color: #F8F8F8;
}
div.CodeExample p {
margin: 0.5em;
border-bottom: 1px solid #DDDDDD;
}
div.CodeExample div {
margin: 0.5em;
}
h4 {
margin-bottom: 0;
}
div.Signature {
border: 1px solid #C0C0C0;
background: #F2F2F2;
padding: 1em;
}
</style>
<script type="text/JavaScript">
function toggle_display (block) {
var w = document.getElementById (block);
var t = document.getElementById (block + ":toggle");
if (w.style.display == "none") {
w.style.display = "block";
t.innerHTML = "⊟";
} else {
w.style.display = "none";
t.innerHTML = "⊞";
}
}
</script>
</head>
<body>
<div class="CollectionTitle">
<a href="../index.html">KiiCloudStorageSDK</a> : <a href="index.html">KiiCorp.Cloud.Storage Namespace</a></div>
<div class="SideBar">
<p>
<a href="#T:KiiCorp.Cloud.Storage.KiiACLListCallback`2">Overview</a>
</p>
<p>
<a href="#T:KiiCorp.Cloud.Storage.KiiACLListCallback`2:Signature">Signature</a>
</p>
<p>
<a href="#T:KiiCorp.Cloud.Storage.KiiACLListCallback`2:Docs">Remarks</a>
</p>
<p>
<a href="#Members">Members</a>
</p>
<p>
<a href="#T:KiiCorp.Cloud.Storage.KiiACLListCallback`2:Members">Member Details</a>
</p>
</div>
<h1 class="PageTitle" id="T:KiiCorp.Cloud.Storage.KiiACLListCallback`2">KiiACLListCallback<T,U> Generic Delegate</h1>
<p class="Summary" id="T:KiiCorp.Cloud.Storage.KiiACLListCallback`2:Summary">
This callback is used when API return a list of KiiACLEntry
</p>
<div>
<h2>Syntax</h2>
<div class="Signature" id="T:KiiCorp.Cloud.Storage.KiiACLListCallback`2:Signature">public delegate <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>KiiACLListCallback<T, U></b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Collections.Generic.IList`1">IList<KiiACLEntry<T, U>></a> list, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Exception">Exception</a> e)<br /> where T : <a href="../KiiCorp.Cloud.Storage/AccessControllable.html">KiiCorp.Cloud.Storage.AccessControllable</a></div>
</div>
<div class="Remarks" id="T:KiiCorp.Cloud.Storage.KiiACLListCallback`2:Docs">
<h4 class="Subsection">Type Parameters</h4>
<blockquote class="SubsectionBox" id="T:KiiCorp.Cloud.Storage.KiiACLListCallback`2:Docs:Type Parameters">
<dl>
<dt>
<i>T</i>
</dt>
<dd>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</dd>
<dt>
<i>U</i>
</dt>
<dd>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</dd>
</dl>
</blockquote>
<h4 class="Subsection">Parameters</h4>
<blockquote class="SubsectionBox" id="T:KiiCorp.Cloud.Storage.KiiACLListCallback`2:Docs:Parameters">
<dl>
<dt>
<i>list</i>
</dt>
<dd>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</dd>
<dt>
<i>e</i>
</dt>
<dd>
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</dd>
</dl>
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="T:KiiCorp.Cloud.Storage.KiiACLListCallback`2:Docs:Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="T:KiiCorp.Cloud.Storage.KiiACLListCallback`2:Docs:Version Information">
<b>Namespace: </b>KiiCorp.Cloud.Storage<br /><b>Assembly: </b>KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)<br /><b>Assembly Versions: </b>3.2.10.0</div>
</div>
<div class="Members" id="T:KiiCorp.Cloud.Storage.KiiACLListCallback`2:Members">
</div>
<hr size="1" />
<div class="Copyright">
</div>
</body>
</html> |
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>CMAKE_Swift_NUM_THREADS — CMake 3.17.2 Documentation</title>
<link rel="stylesheet" href="../_static/cmake.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/cmake-favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="CMAKE_TOOLCHAIN_FILE" href="CMAKE_TOOLCHAIN_FILE.html" />
<link rel="prev" title="CMAKE_Swift_MODULE_DIRECTORY" href="CMAKE_Swift_MODULE_DIRECTORY.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="CMAKE_TOOLCHAIN_FILE.html" title="CMAKE_TOOLCHAIN_FILE"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="CMAKE_Swift_MODULE_DIRECTORY.html" title="CMAKE_Swift_MODULE_DIRECTORY"
accesskey="P">previous</a> |</li>
<li>
<img src="../_static/cmake-logo-16.png" alt=""
style="vertical-align: middle; margin-top: -2px" />
</li>
<li>
<a href="https://cmake.org/">CMake</a> »
</li>
<li>
<a href="../index.html">3.17.2 Documentation</a> »
</li>
<li class="nav-item nav-item-1"><a href="../manual/cmake-variables.7.html" accesskey="U">cmake-variables(7)</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="cmake-swift-num-threads">
<span id="variable:CMAKE_Swift_NUM_THREADS"></span><h1>CMAKE_Swift_NUM_THREADS<a class="headerlink" href="#cmake-swift-num-threads" title="Permalink to this headline">¶</a></h1>
<p>Number of threads for parallel compilation for Swift targets.</p>
<p>This variable controls the number of parallel jobs that the swift driver creates
for building targets. If not specified, it will default to the number of
logical CPUs on the host.</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="CMAKE_Swift_MODULE_DIRECTORY.html"
title="previous chapter">CMAKE_Swift_MODULE_DIRECTORY</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="CMAKE_TOOLCHAIN_FILE.html"
title="next chapter">CMAKE_TOOLCHAIN_FILE</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/variable/CMAKE_Swift_NUM_THREADS.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="CMAKE_TOOLCHAIN_FILE.html" title="CMAKE_TOOLCHAIN_FILE"
>next</a> |</li>
<li class="right" >
<a href="CMAKE_Swift_MODULE_DIRECTORY.html" title="CMAKE_Swift_MODULE_DIRECTORY"
>previous</a> |</li>
<li>
<img src="../_static/cmake-logo-16.png" alt=""
style="vertical-align: middle; margin-top: -2px" />
</li>
<li>
<a href="https://cmake.org/">CMake</a> »
</li>
<li>
<a href="../index.html">3.17.2 Documentation</a> »
</li>
<li class="nav-item nav-item-1"><a href="../manual/cmake-variables.7.html" >cmake-variables(7)</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2000-2020 Kitware, Inc. and Contributors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.2.
</div>
</body>
</html> |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_95) on Tue Oct 22 19:26:32 GMT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Class org.apache.hadoop.metrics2.sink.FileSink (Apache Hadoop Common 2.10.0 API)</title>
<meta name="date" content="2019-10-22">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Class org.apache.hadoop.metrics2.sink.FileSink (Apache Hadoop Common 2.10.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../org/apache/hadoop/metrics2/sink/FileSink.html" title="class in org.apache.hadoop.metrics2.sink">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/metrics2/sink/class-use/FileSink.html" target="_top">Frames</a></li>
<li><a href="FileSink.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.apache.hadoop.metrics2.sink.FileSink" class="title">Uses of Class<br>org.apache.hadoop.metrics2.sink.FileSink</h2>
</div>
<div class="classUseContainer">No usage of org.apache.hadoop.metrics2.sink.FileSink</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../org/apache/hadoop/metrics2/sink/FileSink.html" title="class in org.apache.hadoop.metrics2.sink">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/metrics2/sink/class-use/FileSink.html" target="_top">Frames</a></li>
<li><a href="FileSink.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2019 <a href="https://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>
|
<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>statsmodels.stats.contingency_tables.Table2x2.marginal_probabilities — statsmodels 0.9.0 documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="shortcut icon" href="../_static/statsmodels_hybi_favico.ico"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="statsmodels.stats.contingency_tables.Table2x2.oddsratio" href="statsmodels.stats.contingency_tables.Table2x2.oddsratio.html" />
<link rel="prev" title="statsmodels.stats.contingency_tables.Table2x2.log_riskratio_se" href="statsmodels.stats.contingency_tables.Table2x2.log_riskratio_se.html" />
<link rel="stylesheet" href="../_static/examples.css" type="text/css" />
<link rel="stylesheet" href="../_static/facebox.css" type="text/css" />
<script type="text/javascript" src="../_static/scripts.js">
</script>
<script type="text/javascript" src="../_static/facebox.js">
</script>
<script type="text/javascript">
$.facebox.settings.closeImage = "../_static/closelabel.png"
$.facebox.settings.loadingImage = "../_static/loading.gif"
</script>
</head><body>
<div class="headerwrap">
<div class = "header">
<a href = "../index.html">
<img src="../_static/statsmodels_hybi_banner.png" alt="Logo"
style="padding-left: 15px"/></a>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="statsmodels.stats.contingency_tables.Table2x2.oddsratio.html" title="statsmodels.stats.contingency_tables.Table2x2.oddsratio"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="statsmodels.stats.contingency_tables.Table2x2.log_riskratio_se.html" title="statsmodels.stats.contingency_tables.Table2x2.log_riskratio_se"
accesskey="P">previous</a> |</li>
<li><a href ="../install.html">Install</a></li> |
<li><a href="https://groups.google.com/forum/?hl=en#!forum/pystatsmodels">Support</a></li> |
<li><a href="https://github.com/statsmodels/statsmodels/issues">Bugs</a></li> |
<li><a href="../dev/index.html">Develop</a></li> |
<li><a href="../examples/index.html">Examples</a></li> |
<li><a href="../faq.html">FAQ</a></li> |
<li class="nav-item nav-item-1"><a href="../contingency_tables.html" >Contingency tables</a> |</li>
<li class="nav-item nav-item-2"><a href="statsmodels.stats.contingency_tables.Table2x2.html" accesskey="U">statsmodels.stats.contingency_tables.Table2x2</a> |</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="statsmodels-stats-contingency-tables-table2x2-marginal-probabilities">
<h1>statsmodels.stats.contingency_tables.Table2x2.marginal_probabilities<a class="headerlink" href="#statsmodels-stats-contingency-tables-table2x2-marginal-probabilities" title="Permalink to this headline">¶</a></h1>
<dl class="method">
<dt id="statsmodels.stats.contingency_tables.Table2x2.marginal_probabilities">
<code class="descclassname">Table2x2.</code><code class="descname">marginal_probabilities</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#statsmodels.stats.contingency_tables.Table2x2.marginal_probabilities" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="statsmodels.stats.contingency_tables.Table2x2.log_riskratio_se.html"
title="previous chapter">statsmodels.stats.contingency_tables.Table2x2.log_riskratio_se</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="statsmodels.stats.contingency_tables.Table2x2.oddsratio.html"
title="next chapter">statsmodels.stats.contingency_tables.Table2x2.oddsratio</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/generated/statsmodels.stats.contingency_tables.Table2x2.marginal_probabilities.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2017, Josef Perktold, Skipper Seabold, Jonathan Taylor, statsmodels-developers.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.4.
</div>
</body>
</html> |
<!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>
<title>OR-Tools</title>
<meta http-equiv="Content-Type" content="text/html;"/>
<meta charset="utf-8"/>
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
<link rel="stylesheet" type="text/css" href="ortools.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">Google OR-Tools 7.7</span>
</div>
</div>
<div id="content" style="width: 100%; overflow: hidden;">
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
<h2>C++ Reference</h2>
<ul>
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
<li><a href="../cpp_graph/annotated.html">Graph</a></li>
<li><a href="../cpp_routing/annotated.html">Routing</a></li>
<li><a href="../cpp_linear/annotated.html">Linear solver</a></li>
</ul>
</div>
<div id="content">
<div align="center">
<h1 style="color: #145A32;">C++ Reference: CP-SAT</h1>
</div>
<!-- Generated by Doxygen 1.8.18 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceoperations__research.html">operations_research</a></li><li class="navelem"><a class="el" href="namespaceoperations__research_1_1sat.html">sat</a></li><li class="navelem"><a class="el" href="classoperations__research_1_1sat_1_1NoOverlap2DConstraint.html">NoOverlap2DConstraint</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classoperations__research_1_1sat_1_1NoOverlap2DConstraint-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NoOverlap2DConstraint</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Specialized no_overlap2D constraint. </p>
<p>This constraint allows adding rectangles to the no_overlap2D constraint incrementally. </p>
<p class="definition">Definition at line <a class="el" href="cp__model_8h_source.html#l00562">562</a> of file <a class="el" href="cp__model_8h_source.html">cp_model.h</a>.</p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac9f005471a4a54c288d4dc259d25fbc3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1NoOverlap2DConstraint.html#ac9f005471a4a54c288d4dc259d25fbc3">AddRectangle</a> (<a class="el" href="classoperations__research_1_1sat_1_1IntervalVar.html">IntervalVar</a> x_coordinate, <a class="el" href="classoperations__research_1_1sat_1_1IntervalVar.html">IntervalVar</a> y_coordinate)</td></tr>
<tr class="memdesc:ac9f005471a4a54c288d4dc259d25fbc3"><td class="mdescLeft"> </td><td class="mdescRight">Adds a rectangle (parallel to the axis) to the constraint. <a href="classoperations__research_1_1sat_1_1NoOverlap2DConstraint.html#ac9f005471a4a54c288d4dc259d25fbc3">More...</a><br /></td></tr>
<tr class="separator:ac9f005471a4a54c288d4dc259d25fbc3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ef1ea52810f5cb078f58799520b833c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html">Constraint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html#a0ef1ea52810f5cb078f58799520b833c">OnlyEnforceIf</a> (absl::Span< const <a class="el" href="classoperations__research_1_1sat_1_1BoolVar.html">BoolVar</a> > literals)</td></tr>
<tr class="memdesc:a0ef1ea52810f5cb078f58799520b833c"><td class="mdescLeft"> </td><td class="mdescRight">The constraint will be enforced iff all literals listed here are true. <a href="classoperations__research_1_1sat_1_1Constraint.html#a0ef1ea52810f5cb078f58799520b833c">More...</a><br /></td></tr>
<tr class="separator:a0ef1ea52810f5cb078f58799520b833c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2f0eb6bad7bac457d265320faeeb310"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html">Constraint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html#ad2f0eb6bad7bac457d265320faeeb310">OnlyEnforceIf</a> (<a class="el" href="classoperations__research_1_1sat_1_1BoolVar.html">BoolVar</a> literal)</td></tr>
<tr class="memdesc:ad2f0eb6bad7bac457d265320faeeb310"><td class="mdescLeft"> </td><td class="mdescRight">See <a class="el" href="classoperations__research_1_1sat_1_1Constraint.html#a0ef1ea52810f5cb078f58799520b833c" title="The constraint will be enforced iff all literals listed here are true.">OnlyEnforceIf(absl::Span<const BoolVar> literals)</a>. <a href="classoperations__research_1_1sat_1_1Constraint.html#ad2f0eb6bad7bac457d265320faeeb310">More...</a><br /></td></tr>
<tr class="separator:ad2f0eb6bad7bac457d265320faeeb310"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18bb41d87c6d089385c392476adb6465"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html">Constraint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html#a18bb41d87c6d089385c392476adb6465">WithName</a> (const std::string &name)</td></tr>
<tr class="memdesc:a18bb41d87c6d089385c392476adb6465"><td class="mdescLeft"> </td><td class="mdescRight">Sets the name of the constraint. <a href="classoperations__research_1_1sat_1_1Constraint.html#a18bb41d87c6d089385c392476adb6465">More...</a><br /></td></tr>
<tr class="separator:a18bb41d87c6d089385c392476adb6465"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a191cd9b1ba3e3c01a558a1f6c02a4429"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html#a191cd9b1ba3e3c01a558a1f6c02a4429">Name</a> () const</td></tr>
<tr class="memdesc:a191cd9b1ba3e3c01a558a1f6c02a4429"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the constraint (or the empty string if not set). <a href="classoperations__research_1_1sat_1_1Constraint.html#a191cd9b1ba3e3c01a558a1f6c02a4429">More...</a><br /></td></tr>
<tr class="separator:a191cd9b1ba3e3c01a558a1f6c02a4429"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a808ccd064e687092f93e0d6671536e21"><td class="memItemLeft" align="right" valign="top">const ConstraintProto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html#a808ccd064e687092f93e0d6671536e21">Proto</a> () const</td></tr>
<tr class="memdesc:a808ccd064e687092f93e0d6671536e21"><td class="mdescLeft"> </td><td class="mdescRight">Returns the underlying protobuf object (useful for testing). <a href="classoperations__research_1_1sat_1_1Constraint.html#a808ccd064e687092f93e0d6671536e21">More...</a><br /></td></tr>
<tr class="separator:a808ccd064e687092f93e0d6671536e21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab24547e367af774c764d4fbf76a23223"><td class="memItemLeft" align="right" valign="top">ConstraintProto * </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html#ab24547e367af774c764d4fbf76a23223">MutableProto</a> () const</td></tr>
<tr class="memdesc:ab24547e367af774c764d4fbf76a23223"><td class="mdescLeft"> </td><td class="mdescRight">Returns the mutable underlying protobuf object (useful for model edition). <a href="classoperations__research_1_1sat_1_1Constraint.html#ab24547e367af774c764d4fbf76a23223">More...</a><br /></td></tr>
<tr class="separator:ab24547e367af774c764d4fbf76a23223"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a9ee30a925ae7127a28ae72965c8654d8"><td class="memItemLeft" align="right" valign="top">ConstraintProto * </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html#a9ee30a925ae7127a28ae72965c8654d8">proto_</a> = nullptr</td></tr>
<tr class="separator:a9ee30a925ae7127a28ae72965c8654d8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac9f005471a4a54c288d4dc259d25fbc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9f005471a4a54c288d4dc259d25fbc3">◆ </a></span>AddRectangle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AddRectangle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1sat_1_1IntervalVar.html">IntervalVar</a> </td>
<td class="paramname"><em>x_coordinate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1sat_1_1IntervalVar.html">IntervalVar</a> </td>
<td class="paramname"><em>y_coordinate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a rectangle (parallel to the axis) to the constraint. </p>
</div>
</div>
<a id="ab24547e367af774c764d4fbf76a23223"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab24547e367af774c764d4fbf76a23223">◆ </a></span>MutableProto()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ConstraintProto* MutableProto </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the mutable underlying protobuf object (useful for model edition). </p>
<p class="definition">Definition at line <a class="el" href="cp__model_8h_source.html#l00436">436</a> of file <a class="el" href="cp__model_8h_source.html">cp_model.h</a>.</p>
</div>
</div>
<a id="a191cd9b1ba3e3c01a558a1f6c02a4429"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a191cd9b1ba3e3c01a558a1f6c02a4429">◆ </a></span>Name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string& Name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of the constraint (or the empty string if not set). </p>
</div>
</div>
<a id="a0ef1ea52810f5cb078f58799520b833c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ef1ea52810f5cb078f58799520b833c">◆ </a></span>OnlyEnforceIf() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html">Constraint</a> OnlyEnforceIf </td>
<td>(</td>
<td class="paramtype">absl::Span< const <a class="el" href="classoperations__research_1_1sat_1_1BoolVar.html">BoolVar</a> > </td>
<td class="paramname"><em>literals</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The constraint will be enforced iff all literals listed here are true. </p>
<p>If this is empty, then the constraint will always be enforced. An enforced constraint must be satisfied, and an un-enforced one will simply be ignored.</p>
<p>This is also called half-reification. To have an equivalence between a literal and a constraint (full reification), one must add both a constraint (controlled by a literal l) and its negation (controlled by the negation of l).</p>
<p>Important: as of September 2018, only a few constraint support enforcement:</p><ul>
<li>bool_or, bool_and, linear: fully supported.</li>
<li>interval: only support a single enforcement literal.</li>
<li>other: no support (but can be added on a per-demand basis). </li>
</ul>
</div>
</div>
<a id="ad2f0eb6bad7bac457d265320faeeb310"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2f0eb6bad7bac457d265320faeeb310">◆ </a></span>OnlyEnforceIf() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html">Constraint</a> OnlyEnforceIf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1sat_1_1BoolVar.html">BoolVar</a> </td>
<td class="paramname"><em>literal</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>See <a class="el" href="classoperations__research_1_1sat_1_1Constraint.html#a0ef1ea52810f5cb078f58799520b833c" title="The constraint will be enforced iff all literals listed here are true.">OnlyEnforceIf(absl::Span<const BoolVar> literals)</a>. </p>
</div>
</div>
<a id="a808ccd064e687092f93e0d6671536e21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a808ccd064e687092f93e0d6671536e21">◆ </a></span>Proto()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const ConstraintProto& Proto </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the underlying protobuf object (useful for testing). </p>
<p class="definition">Definition at line <a class="el" href="cp__model_8h_source.html#l00433">433</a> of file <a class="el" href="cp__model_8h_source.html">cp_model.h</a>.</p>
</div>
</div>
<a id="a18bb41d87c6d089385c392476adb6465"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18bb41d87c6d089385c392476adb6465">◆ </a></span>WithName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1sat_1_1Constraint.html">Constraint</a> WithName </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the name of the constraint. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9ee30a925ae7127a28ae72965c8654d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ee30a925ae7127a28ae72965c8654d8">◆ </a></span>proto_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ConstraintProto* proto_ = nullptr</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="cp__model_8h_source.html#l00443">443</a> of file <a class="el" href="cp__model_8h_source.html">cp_model.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cp__model_8h_source.html">cp_model.h</a></li>
</ul>
</div><!-- contents -->
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_211) on Tue Feb 23 15:18:52 PST 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Index (JSON Library 1.1.0 API)</title>
<meta name="date" content="2021-02-23">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Index (JSON Library 1.1.0 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="contentContainer"><a href="#I:A">A</a> <a href="#I:C">C</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:J">J</a> <a href="#I:K">K</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:V">V</a> <a name="I:A">
<!-- -->
</a>
<h2 class="title">A</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJTranslator.JSONValueStreamer.html#advance--">advance()</a></span> - Method in class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJTranslator.JSONValueStreamer.html" title="class in io.github.utk003.json.ooj">OOJTranslator.JSONValueStreamer</a></dt>
<dd>
<div class="block">Advances to and returns the next token for this <code>Scanner</code></div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/scanner/JSONScanner.html#advance--">advance()</a></span> - Method in class io.github.utk003.json.scanner.<a href="io/github/utk003/json/scanner/JSONScanner.html" title="class in io.github.utk003.json.scanner">JSONScanner</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/scanner/Scanner.html#advance--">advance()</a></span> - Method in interface io.github.utk003.json.scanner.<a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner">Scanner</a></dt>
<dd>
<div class="block">Advances to and returns the next token for this <code>Scanner</code></div>
</dd>
</dl>
<a name="I:C">
<!-- -->
</a>
<h2 class="title">C</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJTranslator.JSONValueStreamer.html#current--">current()</a></span> - Method in class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJTranslator.JSONValueStreamer.html" title="class in io.github.utk003.json.ooj">OOJTranslator.JSONValueStreamer</a></dt>
<dd>
<div class="block">Returns the current token associated with this <code>Scanner</code></div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/scanner/JSONScanner.html#current--">current()</a></span> - Method in class io.github.utk003.json.scanner.<a href="io/github/utk003/json/scanner/JSONScanner.html" title="class in io.github.utk003.json.scanner">JSONScanner</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/scanner/Scanner.html#current--">current()</a></span> - Method in interface io.github.utk003.json.scanner.<a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner">Scanner</a></dt>
<dd>
<div class="block">Returns the current token associated with this <code>Scanner</code></div>
</dd>
</dl>
<a name="I:E">
<!-- -->
</a>
<h2 class="title">E</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONNumber.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONNumber.html" title="class in io.github.utk003.json.traditional.node">JSONNumber</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONObject.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node">JSONObject</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONPrimitive.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONPrimitive.html" title="class in io.github.utk003.json.traditional.node">JSONPrimitive</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONString.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONString.html" title="class in io.github.utk003.json.traditional.node">JSONString</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
</dl>
<a name="I:F">
<!-- -->
</a>
<h2 class="title">F</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#findElements-io.github.utk003.json.traditional.node.JSONValue.PathTrace:A-int-">findElements(JSONValue.PathTrace[], int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">A protected helper for <a href="io/github/utk003/json/traditional/node/JSONValue.html#findElements-java.lang.String-"><code>JSONValue.findElements(String)</code></a> that must
be implemented by any subclass.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONNumber.html#findElements-io.github.utk003.json.traditional.node.JSONValue.PathTrace:A-int-">findElements(JSONValue.PathTrace[], int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONNumber.html" title="class in io.github.utk003.json.traditional.node">JSONNumber</a></dt>
<dd>
<div class="block">A protected helper for <a href="io/github/utk003/json/traditional/node/JSONValue.html#findElements-java.lang.String-"><code>JSONValue.findElements(String)</code></a> that must
be implemented by any subclass.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONObject.html#findElements-io.github.utk003.json.traditional.node.JSONValue.PathTrace:A-int-">findElements(JSONValue.PathTrace[], int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node">JSONObject</a></dt>
<dd>
<div class="block">A protected helper for <a href="io/github/utk003/json/traditional/node/JSONValue.html#findElements-java.lang.String-"><code>JSONValue.findElements(String)</code></a> that must
be implemented by any subclass.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONPrimitive.html#findElements-io.github.utk003.json.traditional.node.JSONValue.PathTrace:A-int-">findElements(JSONValue.PathTrace[], int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONPrimitive.html" title="class in io.github.utk003.json.traditional.node">JSONPrimitive</a></dt>
<dd>
<div class="block">A protected helper for <a href="io/github/utk003/json/traditional/node/JSONValue.html#findElements-java.lang.String-"><code>JSONValue.findElements(String)</code></a> that must
be implemented by any subclass.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONString.html#findElements-io.github.utk003.json.traditional.node.JSONValue.PathTrace:A-int-">findElements(JSONValue.PathTrace[], int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONString.html" title="class in io.github.utk003.json.traditional.node">JSONString</a></dt>
<dd>
<div class="block">A protected helper for <a href="io/github/utk003/json/traditional/node/JSONValue.html#findElements-java.lang.String-"><code>JSONValue.findElements(String)</code></a> that must
be implemented by any subclass.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#findElements-java.lang.String-">findElements(String)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">Returns a <code>Collection</code> of <code>JSONValue</code>s corresponding
to all elements in the JSON tree rooted at this <code>JSONValue</code>
whose path in the tree matches the targt path specified by the
<code>path</code> argument.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#findElements-io.github.utk003.json.traditional.node.JSONValue.PathTrace:A-int-">findElements(JSONValue.PathTrace[], int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">A protected helper for <a href="io/github/utk003/json/traditional/node/JSONValue.html#findElements-java.lang.String-"><code>JSONValue.findElements(String)</code></a> that must
be implemented by any subclass.</div>
</dd>
</dl>
<a name="I:G">
<!-- -->
</a>
<h2 class="title">G</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJArray.html#get-int-">get(int)</a></span> - Method in interface io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJArray.html" title="interface in io.github.utk003.json.ooj">OOJArray</a></dt>
<dd>
<div class="block">Gets the element at the specified index, and throws an
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/ArrayIndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang"><code>ArrayIndexOutOfBoundsException</code></a> if the index is out of bounds.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#getElement-java.lang.Integer-">getElement(Integer)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">Gets the child <code>JSONValue</code> element indentified by the specified key/index</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONObject.html#getElement-java.lang.String-">getElement(String)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node">JSONObject</a></dt>
<dd>
<div class="block">Gets the child <code>JSONValue</code> element indentified by the specified key/index</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONStorageElement.html#getElement-E-">getElement(E)</a></span> - Method in interface io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONStorageElement.html" title="interface in io.github.utk003.json.traditional.node">JSONStorageElement</a></dt>
<dd>
<div class="block">Gets the child <code>JSONValue</code> element indentified by the specified key/index</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#getElements--">getElements()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">Returns an immutable <code>Collection</code> of all <code>JSONValue</code> children this <code>JSONStorageElement</code> has.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONObject.html#getElements--">getElements()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node">JSONObject</a></dt>
<dd>
<div class="block">Returns an immutable <code>Collection</code> of all <code>JSONValue</code> children this <code>JSONStorageElement</code> has.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONStorageElement.html#getElements--">getElements()</a></span> - Method in interface io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONStorageElement.html" title="interface in io.github.utk003.json.traditional.node">JSONStorageElement</a></dt>
<dd>
<div class="block">Returns an immutable <code>Collection</code> of all <code>JSONValue</code> children this <code>JSONStorageElement</code> has.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#getElementsPaired--">getElementsPaired()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">Returns an <a href="https://utk003.github.io/Utilities/javadoc/1.1.0/apidocs/io/github/utk003/util/data/immutable/ImmutablePair.html?is-external=true" title="class or interface in io.github.utk003.util.data.immutable"><code>ImmutablePair</code></a> of <code>LinkedList</code>s that
hold all of this <code>JSONStorageElement</code>'s <code>JSONValue</code>
children as well as their corresponding keys/indices.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONObject.html#getElementsPaired--">getElementsPaired()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node">JSONObject</a></dt>
<dd>
<div class="block">Returns an <a href="https://utk003.github.io/Utilities/javadoc/1.1.0/apidocs/io/github/utk003/util/data/immutable/ImmutablePair.html?is-external=true" title="class or interface in io.github.utk003.util.data.immutable"><code>ImmutablePair</code></a> of <code>LinkedList</code>s that
hold all of this <code>JSONStorageElement</code>'s <code>JSONValue</code>
children as well as their corresponding keys/indices.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONStorageElement.html#getElementsPaired--">getElementsPaired()</a></span> - Method in interface io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONStorageElement.html" title="interface in io.github.utk003.json.traditional.node">JSONStorageElement</a></dt>
<dd>
<div class="block">Returns an <a href="https://utk003.github.io/Utilities/javadoc/1.1.0/apidocs/io/github/utk003/util/data/immutable/ImmutablePair.html?is-external=true" title="class or interface in io.github.utk003.util.data.immutable"><code>ImmutablePair</code></a> of <code>LinkedList</code>s that
hold all of this <code>JSONStorageElement</code>'s <code>JSONValue</code>
children as well as their corresponding keys/indices.</div>
</dd>
</dl>
<a name="I:H">
<!-- -->
</a>
<h2 class="title">H</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#hashCode--">hashCode()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONNumber.html#hashCode--">hashCode()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONNumber.html" title="class in io.github.utk003.json.traditional.node">JSONNumber</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONObject.html#hashCode--">hashCode()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node">JSONObject</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONPrimitive.html#hashCode--">hashCode()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONPrimitive.html" title="class in io.github.utk003.json.traditional.node">JSONPrimitive</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONString.html#hashCode--">hashCode()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONString.html" title="class in io.github.utk003.json.traditional.node">JSONString</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#hashCode--">hashCode()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJTranslator.JSONValueStreamer.html#hasMore--">hasMore()</a></span> - Method in class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJTranslator.JSONValueStreamer.html" title="class in io.github.utk003.json.ooj">OOJTranslator.JSONValueStreamer</a></dt>
<dd>
<div class="block">Returns whether or not there are any more tokens to be parsed</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/scanner/JSONScanner.html#hasMore--">hasMore()</a></span> - Method in class io.github.utk003.json.scanner.<a href="io/github/utk003/json/scanner/JSONScanner.html" title="class in io.github.utk003.json.scanner">JSONScanner</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/scanner/Scanner.html#hasMore--">hasMore()</a></span> - Method in interface io.github.utk003.json.scanner.<a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner">Scanner</a></dt>
<dd>
<div class="block">Returns whether or not there are any more tokens to be parsed</div>
</dd>
</dl>
<a name="I:I">
<!-- -->
</a>
<h2 class="title">I</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.PathTrace.html#INDEX">INDEX</a></span> - Variable in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.PathTrace.html" title="class in io.github.utk003.json.traditional.node">JSONValue.PathTrace</a></dt>
<dd>
<div class="block">The (potential) index this <code>PathTrace</code> represents in a JSON array.</div>
</dd>
<dt><a href="io/github/utk003/json/package-summary.html">io.github.utk003.json</a> - package io.github.utk003.json</dt>
<dd>
<div class="block">The package for all JSON-related functionality.</div>
</dd>
<dt><a href="io/github/utk003/json/ooj/package-summary.html">io.github.utk003.json.ooj</a> - package io.github.utk003.json.ooj</dt>
<dd>
<div class="block">The "Object-Oriented JSON" package provides utilities for
converting JSON into custom Java objects.</div>
</dd>
<dt><a href="io/github/utk003/json/scanner/package-summary.html">io.github.utk003.json.scanner</a> - package io.github.utk003.json.scanner</dt>
<dd>
<div class="block">The scanner package provides template scanners for use in JSON parsing.</div>
</dd>
<dt><a href="io/github/utk003/json/traditional/package-summary.html">io.github.utk003.json.traditional</a> - package io.github.utk003.json.traditional</dt>
<dd>
<div class="block">The traditional JSON parsing package provides utilities for converting JSON
into a tree with <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a> nodes.</div>
</dd>
<dt><a href="io/github/utk003/json/traditional/node/package-summary.html">io.github.utk003.json.traditional.node</a> - package io.github.utk003.json.traditional.node</dt>
<dd>
<div class="block">The package for the node classes of a traditional JSON tree.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#isEmpty--">isEmpty()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">Returns true if and only if this <code>JSONStorageElement</code> has no children.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONObject.html#isEmpty--">isEmpty()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node">JSONObject</a></dt>
<dd>
<div class="block">Returns true if and only if this <code>JSONStorageElement</code> has no children.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONStorageElement.html#isEmpty--">isEmpty()</a></span> - Method in interface io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONStorageElement.html" title="interface in io.github.utk003.json.traditional.node">JSONStorageElement</a></dt>
<dd>
<div class="block">Returns true if and only if this <code>JSONStorageElement</code> has no children.</div>
</dd>
</dl>
<a name="I:J">
<!-- -->
</a>
<h2 class="title">J</h2>
<dl>
<dt><a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node"><span class="typeNameLink">JSONArray</span></a> - Class in <a href="io/github/utk003/json/traditional/node/package-summary.html">io.github.utk003.json.traditional.node</a></dt>
<dd>
<div class="block">A <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a> that represents a JSON array.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#JSONArray-java.lang.String-">JSONArray(String)</a></span> - Constructor for class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">Creates a new <code>JSONArray</code> with the specified path in the JSON tree.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#JSONArray-io.github.utk003.json.traditional.node.JSONValue:A-java.lang.String-">JSONArray(JSONValue[], String)</a></span> - Constructor for class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">Creates a new <code>JSONArray</code> with the specified path in the JSON tree
and the specified array of <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a>s as this array's elements.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#JSONArray-java.util.List-java.lang.String-">JSONArray(List<JSONValue>, String)</a></span> - Constructor for class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">Creates a new <code>JSONArray</code> with the specified path in the JSON tree
and the specified <code>List</code> of <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a>s as this array's elements.</div>
</dd>
<dt><a href="io/github/utk003/json/traditional/node/JSONNumber.html" title="class in io.github.utk003.json.traditional.node"><span class="typeNameLink">JSONNumber</span></a> - Class in <a href="io/github/utk003/json/traditional/node/package-summary.html">io.github.utk003.json.traditional.node</a></dt>
<dd>
<div class="block">A <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a> that represents a JSON number.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONNumber.html#JSONNumber-java.lang.String-java.lang.String-">JSONNumber(String, String)</a></span> - Constructor for class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONNumber.html" title="class in io.github.utk003.json.traditional.node">JSONNumber</a></dt>
<dd>
<div class="block">Creates a <code>JSONNumber</code> from the given <code>String</code> and with the given path</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONNumber.html#JSONNumber-java.lang.Number-java.lang.String-">JSONNumber(Number, String)</a></span> - Constructor for class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONNumber.html" title="class in io.github.utk003.json.traditional.node">JSONNumber</a></dt>
<dd>
<div class="block">Creates a <code>JSONNumber</code> from the given <code>Number</code> and with the given path</div>
</dd>
<dt><a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node"><span class="typeNameLink">JSONObject</span></a> - Class in <a href="io/github/utk003/json/traditional/node/package-summary.html">io.github.utk003.json.traditional.node</a></dt>
<dd>
<div class="block">A <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a> that represents a JSON object.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONObject.html#JSONObject-java.lang.String-">JSONObject(String)</a></span> - Constructor for class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node">JSONObject</a></dt>
<dd>
<div class="block">Creates a new <code>JSONObject</code> with the specified path in the JSON tree.</div>
</dd>
<dt><a href="io/github/utk003/json/traditional/JSONParser.html" title="class in io.github.utk003.json.traditional"><span class="typeNameLink">JSONParser</span></a> - Class in <a href="io/github/utk003/json/traditional/package-summary.html">io.github.utk003.json.traditional</a></dt>
<dd>
<div class="block">A parser for creating JSON trees with <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a> nodes from
some form of <a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner"><code>Scanner</code></a> or <code>Scanner</code>-accepted input format.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/JSONParser.html#JSONParser--">JSONParser()</a></span> - Constructor for class io.github.utk003.json.traditional.<a href="io/github/utk003/json/traditional/JSONParser.html" title="class in io.github.utk003.json.traditional">JSONParser</a></dt>
<dd> </dd>
<dt><a href="io/github/utk003/json/traditional/node/JSONPrimitive.html" title="class in io.github.utk003.json.traditional.node"><span class="typeNameLink">JSONPrimitive</span></a> - Class in <a href="io/github/utk003/json/traditional/node/package-summary.html">io.github.utk003.json.traditional.node</a></dt>
<dd>
<div class="block">A <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a> that represents a JSON primitive (a boolean or <code>null</code>).</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONPrimitive.html#JSONPrimitive-java.lang.Boolean-java.lang.String-">JSONPrimitive(Boolean, String)</a></span> - Constructor for class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONPrimitive.html" title="class in io.github.utk003.json.traditional.node">JSONPrimitive</a></dt>
<dd>
<div class="block">Creates a <code>JSONPrimitive</code> from the given <code>Boolean</code> and with the given path</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONPrimitive.html#JSONPrimitive-java.lang.String-java.lang.String-">JSONPrimitive(String, String)</a></span> - Constructor for class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONPrimitive.html" title="class in io.github.utk003.json.traditional.node">JSONPrimitive</a></dt>
<dd>
<div class="block">Creates a <code>JSONPrimitive</code> from the given <code>String</code> and with the given path</div>
</dd>
<dt><a href="io/github/utk003/json/scanner/JSONScanner.html" title="class in io.github.utk003.json.scanner"><span class="typeNameLink">JSONScanner</span></a> - Class in <a href="io/github/utk003/json/scanner/package-summary.html">io.github.utk003.json.scanner</a></dt>
<dd>
<div class="block">A default implementation of <a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner"><code>Scanner</code></a></div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/scanner/JSONScanner.html#JSONScanner-java.io.InputStream-">JSONScanner(InputStream)</a></span> - Constructor for class io.github.utk003.json.scanner.<a href="io/github/utk003/json/scanner/JSONScanner.html" title="class in io.github.utk003.json.scanner">JSONScanner</a></dt>
<dd>
<div class="block">Creates a new <code>JSONScanner</code> bound to the given <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a></div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/scanner/JSONScanner.html#JSONScanner-java.io.InputStream-boolean-boolean-">JSONScanner(InputStream, boolean, boolean)</a></span> - Constructor for class io.github.utk003.json.scanner.<a href="io/github/utk003/json/scanner/JSONScanner.html" title="class in io.github.utk003.json.scanner">JSONScanner</a></dt>
<dd>
<div class="block">Creates a new <code>JSONScanner</code> bound to the given <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a> and
configured with the given configuration arguments</div>
</dd>
<dt><a href="io/github/utk003/json/traditional/node/JSONStorageElement.html" title="interface in io.github.utk003.json.traditional.node"><span class="typeNameLink">JSONStorageElement</span></a><<a href="io/github/utk003/json/traditional/node/JSONStorageElement.html" title="type parameter in JSONStorageElement">E</a>> - Interface in <a href="io/github/utk003/json/traditional/node/package-summary.html">io.github.utk003.json.traditional.node</a></dt>
<dd>
<div class="block">An interface that represents the two JSON element types that can
hold other elements as children in a JSON tree: objects and arrays.</div>
</dd>
<dt><a href="io/github/utk003/json/traditional/node/JSONString.html" title="class in io.github.utk003.json.traditional.node"><span class="typeNameLink">JSONString</span></a> - Class in <a href="io/github/utk003/json/traditional/node/package-summary.html">io.github.utk003.json.traditional.node</a></dt>
<dd>
<div class="block">A <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a> that represents a JSON string.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONString.html#JSONString-java.lang.String-java.lang.String-">JSONString(String, String)</a></span> - Constructor for class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONString.html" title="class in io.github.utk003.json.traditional.node">JSONString</a></dt>
<dd>
<div class="block">Creates a <code>JSONString</code> from the given <code>String</code> and with the given path</div>
</dd>
<dt><a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><span class="typeNameLink">JSONValue</span></a> - Class in <a href="io/github/utk003/json/traditional/node/package-summary.html">io.github.utk003.json.traditional.node</a></dt>
<dd>
<div class="block">An abstract class that represents a node for a JSON tree.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#JSONValue-io.github.utk003.json.traditional.node.JSONValue.ValueType-java.lang.String-">JSONValue(JSONValue.ValueType, String)</a></span> - Constructor for class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">Creates a new <code>JSONValue</code> with the given type and path.</div>
</dd>
<dt><a href="io/github/utk003/json/traditional/node/JSONValue.PathTrace.html" title="class in io.github.utk003.json.traditional.node"><span class="typeNameLink">JSONValue.PathTrace</span></a> - Class in <a href="io/github/utk003/json/traditional/node/package-summary.html">io.github.utk003.json.traditional.node</a></dt>
<dd>
<div class="block">An internal utility class for tracking whether or not
a <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a>'s path matches the search expression.</div>
</dd>
<dt><a href="io/github/utk003/json/traditional/node/JSONValue.ValueType.html" title="enum in io.github.utk003.json.traditional.node"><span class="typeNameLink">JSONValue.ValueType</span></a> - Enum in <a href="io/github/utk003/json/traditional/node/package-summary.html">io.github.utk003.json.traditional.node</a></dt>
<dd>
<div class="block">An enum for all the different possible types of <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJTranslator.JSONValueStreamer.html#JSONValueStreamer-io.github.utk003.json.traditional.node.JSONValue-">JSONValueStreamer(JSONValue)</a></span> - Constructor for class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJTranslator.JSONValueStreamer.html" title="class in io.github.utk003.json.ooj">OOJTranslator.JSONValueStreamer</a></dt>
<dd>
<div class="block">Creates a new <code>JSONValueStreamer</code> that will stream
the JSON of the tree rooted at the specified root.</div>
</dd>
</dl>
<a name="I:K">
<!-- -->
</a>
<h2 class="title">K</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.PathTrace.html#KEY">KEY</a></span> - Variable in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.PathTrace.html" title="class in io.github.utk003.json.traditional.node">JSONValue.PathTrace</a></dt>
<dd>
<div class="block">The (potential) <code>String</code> key this <code>PathTrace</code> represents for a JSON object.</div>
</dd>
</dl>
<a name="I:M">
<!-- -->
</a>
<h2 class="title">M</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#modifyElement-java.lang.Integer-io.github.utk003.json.traditional.node.JSONValue-">modifyElement(Integer, JSONValue)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">Modifies the child with the specified key/index to the newly specified <code>JSONValue</code> element.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONObject.html#modifyElement-java.lang.String-io.github.utk003.json.traditional.node.JSONValue-">modifyElement(String, JSONValue)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node">JSONObject</a></dt>
<dd>
<div class="block">Modifies the child with the specified key/index to the newly specified <code>JSONValue</code> element.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONStorageElement.html#modifyElement-E-io.github.utk003.json.traditional.node.JSONValue-">modifyElement(E, JSONValue)</a></span> - Method in interface io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONStorageElement.html" title="interface in io.github.utk003.json.traditional.node">JSONStorageElement</a></dt>
<dd>
<div class="block">Modifies the child with the specified key/index to the newly specified <code>JSONValue</code> element.</div>
</dd>
</dl>
<a name="I:N">
<!-- -->
</a>
<h2 class="title">N</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONNumber.html#NUMBER">NUMBER</a></span> - Variable in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONNumber.html" title="class in io.github.utk003.json.traditional.node">JSONNumber</a></dt>
<dd>
<div class="block">A publicly accessible reference to the <code>Number</code> this <code>JSONNumber</code> represents.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#numElements--">numElements()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">Returns how many children this <code>JSONStorageElement</code> has.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONObject.html#numElements--">numElements()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node">JSONObject</a></dt>
<dd>
<div class="block">Returns how many children this <code>JSONStorageElement</code> has.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONStorageElement.html#numElements--">numElements()</a></span> - Method in interface io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONStorageElement.html" title="interface in io.github.utk003.json.traditional.node">JSONStorageElement</a></dt>
<dd>
<div class="block">Returns how many children this <code>JSONStorageElement</code> has.</div>
</dd>
</dl>
<a name="I:O">
<!-- -->
</a>
<h2 class="title">O</h2>
<dl>
<dt><a href="io/github/utk003/json/ooj/OOJArray.html" title="interface in io.github.utk003.json.ooj"><span class="typeNameLink">OOJArray</span></a> - Interface in <a href="io/github/utk003/json/ooj/package-summary.html">io.github.utk003.json.ooj</a></dt>
<dd>
<div class="block">A template interface that can be extended by any class that
wishes to represent a JSON array for class-based OOJ JSON parsing.</div>
</dd>
<dt><a href="io/github/utk003/json/ooj/OOJParser.html" title="class in io.github.utk003.json.ooj"><span class="typeNameLink">OOJParser</span></a> - Class in <a href="io/github/utk003/json/ooj/package-summary.html">io.github.utk003.json.ooj</a></dt>
<dd>
<div class="block">A parser for converting JSON into POJO classes from some form
of <a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner"><code>Scanner</code></a> or <code>Scanner</code>-accepted input format.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJParser.html#OOJParser--">OOJParser()</a></span> - Constructor for class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJParser.html" title="class in io.github.utk003.json.ooj">OOJParser</a></dt>
<dd> </dd>
<dt><a href="io/github/utk003/json/ooj/OOJTranslator.html" title="class in io.github.utk003.json.ooj"><span class="typeNameLink">OOJTranslator</span></a> - Class in <a href="io/github/utk003/json/ooj/package-summary.html">io.github.utk003.json.ooj</a></dt>
<dd>
<div class="block">A translator for converting traditional JSON trees
(<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a>s) into POJOs using a <a href="io/github/utk003/json/ooj/OOJParser.html" title="class in io.github.utk003.json.ooj"><code>OOJParser</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJTranslator.html#OOJTranslator--">OOJTranslator()</a></span> - Constructor for class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJTranslator.html" title="class in io.github.utk003.json.ooj">OOJTranslator</a></dt>
<dd> </dd>
<dt><a href="io/github/utk003/json/ooj/OOJTranslator.JSONValueStreamer.html" title="class in io.github.utk003.json.ooj"><span class="typeNameLink">OOJTranslator.JSONValueStreamer</span></a> - Class in <a href="io/github/utk003/json/ooj/package-summary.html">io.github.utk003.json.ooj</a></dt>
<dd>
<div class="block">A utility <a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner"><code>Scanner</code></a> that streams a JSON tree on-the-fly
for use in re-parsing the JSON or in outputting the original JSON.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#outputNewLine-java.io.PrintStream-">outputNewLine(PrintStream)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">A protected utility method for printing a new line to the specified <a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io"><code>PrintStream</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#outputString-java.io.PrintStream-java.lang.String-">outputString(PrintStream, String)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">A protected utility method for printing the specified <code>String</code>
to the specified <a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io"><code>PrintStream</code></a> with a depth of <code>0</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#outputString-java.io.PrintStream-java.lang.String-int-">outputString(PrintStream, String, int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">A protected utility method for printing the specified <code>String</code>
to the specified <a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io"><code>PrintStream</code></a> with the specified depth.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#outputStringWithNewLine-java.io.PrintStream-java.lang.String-">outputStringWithNewLine(PrintStream, String)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">A protected utility method for printing the specified <code>String</code>
to the specified <a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io"><code>PrintStream</code></a> followed by a new line.</div>
</dd>
</dl>
<a name="I:P">
<!-- -->
</a>
<h2 class="title">P</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#parseJSON-io.github.utk003.json.scanner.Scanner-">parseJSON(Scanner)</a></span> - Static method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">Parses a JSON tree from the input scanner and returns
a <code>JSONValue</code> corresponding to the root of the tree.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJParser.html#parseNonRecursive-java.io.InputStream-java.lang.Class-">parseNonRecursive(InputStream, Class<T>)</a></span> - Method in class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJParser.html" title="class in io.github.utk003.json.ooj">OOJParser</a></dt>
<dd>
<div class="block">Parses JSON into an object of type <code>T</code> non-recursively from the given <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJParser.html#parseNonRecursive-io.github.utk003.json.scanner.Scanner-java.lang.Class-">parseNonRecursive(Scanner, Class<T>)</a></span> - Method in class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJParser.html" title="class in io.github.utk003.json.ooj">OOJParser</a></dt>
<dd>
<div class="block">Parses JSON into an object of type <code>T</code> non-recursively from the given <a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner"><code>Scanner</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJTranslator.html#parseNonRecursive-io.github.utk003.json.ooj.OOJParser-io.github.utk003.json.traditional.node.JSONValue-java.lang.Class-">parseNonRecursive(OOJParser, JSONValue, Class<T>)</a></span> - Method in class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJTranslator.html" title="class in io.github.utk003.json.ooj">OOJTranslator</a></dt>
<dd>
<div class="block">Non-recursively translates the given JSON tree rooted at the
<code>root</code> argument using the given <a href="io/github/utk003/json/ooj/OOJParser.html" title="class in io.github.utk003.json.ooj"><code>OOJParser</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/JSONParser.html#parseNonRecursive-java.io.InputStream-">parseNonRecursive(InputStream)</a></span> - Static method in class io.github.utk003.json.traditional.<a href="io/github/utk003/json/traditional/JSONParser.html" title="class in io.github.utk003.json.traditional">JSONParser</a></dt>
<dd>
<div class="block">Parses a <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a> non-recursively from the given <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/JSONParser.html#parseNonRecursive-io.github.utk003.json.scanner.Scanner-">parseNonRecursive(Scanner)</a></span> - Static method in class io.github.utk003.json.traditional.<a href="io/github/utk003/json/traditional/JSONParser.html" title="class in io.github.utk003.json.traditional">JSONParser</a></dt>
<dd>
<div class="block">Parses a <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a> non-recursively from the given <a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner"><code>Scanner</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJParser.html#parseRecursive-java.io.InputStream-java.lang.Class-">parseRecursive(InputStream, Class<T>)</a></span> - Method in class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJParser.html" title="class in io.github.utk003.json.ooj">OOJParser</a></dt>
<dd>
<div class="block">Parses JSON into an object of type <code>T</code> recursively from the given <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJParser.html#parseRecursive-io.github.utk003.json.scanner.Scanner-java.lang.Class-">parseRecursive(Scanner, Class<T>)</a></span> - Method in class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJParser.html" title="class in io.github.utk003.json.ooj">OOJParser</a></dt>
<dd>
<div class="block">Parses JSON into an object of type <code>T</code> recursively from the given <a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner"><code>Scanner</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/JSONParser.html#parseRecursive-java.io.InputStream-">parseRecursive(InputStream)</a></span> - Static method in class io.github.utk003.json.traditional.<a href="io/github/utk003/json/traditional/JSONParser.html" title="class in io.github.utk003.json.traditional">JSONParser</a></dt>
<dd>
<div class="block">Parses a <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a> recursively from the given <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/JSONParser.html#parseRecursive-io.github.utk003.json.scanner.Scanner-">parseRecursive(Scanner)</a></span> - Static method in class io.github.utk003.json.traditional.<a href="io/github/utk003/json/traditional/JSONParser.html" title="class in io.github.utk003.json.traditional">JSONParser</a></dt>
<dd>
<div class="block">Parses a <a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node"><code>JSONValue</code></a> recursively from the given <a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner"><code>Scanner</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#PATH">PATH</a></span> - Variable in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">This <code>JSONValue</code>'s path in its JSON tree</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#print-java.io.PrintStream-int-">print(PrintStream, int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">Prints the children of this <code>JSONValue</code> in a nicely formatted
way by using the <code>outputString(...)</code> methods provided by this class.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONNumber.html#print-java.io.PrintStream-int-">print(PrintStream, int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONNumber.html" title="class in io.github.utk003.json.traditional.node">JSONNumber</a></dt>
<dd>
<div class="block">Prints the children of this <code>JSONValue</code> in a nicely formatted
way by using the <code>outputString(...)</code> methods provided by this class.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONObject.html#print-java.io.PrintStream-int-">print(PrintStream, int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node">JSONObject</a></dt>
<dd>
<div class="block">Prints the children of this <code>JSONValue</code> in a nicely formatted
way by using the <code>outputString(...)</code> methods provided by this class.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONPrimitive.html#print-java.io.PrintStream-int-">print(PrintStream, int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONPrimitive.html" title="class in io.github.utk003.json.traditional.node">JSONPrimitive</a></dt>
<dd>
<div class="block">Prints the children of this <code>JSONValue</code> in a nicely formatted
way by using the <code>outputString(...)</code> methods provided by this class.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONString.html#print-java.io.PrintStream-int-">print(PrintStream, int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONString.html" title="class in io.github.utk003.json.traditional.node">JSONString</a></dt>
<dd>
<div class="block">Prints the children of this <code>JSONValue</code> in a nicely formatted
way by using the <code>outputString(...)</code> methods provided by this class.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#print-java.io.PrintStream-">print(PrintStream)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">Prints this <code>JSONValue</code> to the specified <a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io"><code>PrintStream</code></a>
in a nicely formatted way.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#print-java.io.PrintStream-int-">print(PrintStream, int)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">Prints the children of this <code>JSONValue</code> in a nicely formatted
way by using the <code>outputString(...)</code> methods provided by this class.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#println-java.io.PrintStream-">println(PrintStream)</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">Prints this <code>JSONValue</code> to the specified <a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io"><code>PrintStream</code></a>
in a nicely formatted way.</div>
</dd>
</dl>
<a name="I:R">
<!-- -->
</a>
<h2 class="title">R</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJParser.html#removeArrayTransformer-java.lang.Class-">removeArrayTransformer(Class<?>)</a></span> - Method in class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJParser.html" title="class in io.github.utk003.json.ooj">OOJParser</a></dt>
<dd>
<div class="block">Removes the specified JSON-array-to-class transformer.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#ROOT_PATH">ROOT_PATH</a></span> - Static variable in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">The default path to the root element of a JSON tree.</div>
</dd>
</dl>
<a name="I:S">
<!-- -->
</a>
<h2 class="title">S</h2>
<dl>
<dt><a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner"><span class="typeNameLink">Scanner</span></a> - Interface in <a href="io/github/utk003/json/scanner/package-summary.html">io.github.utk003.json.scanner</a></dt>
<dd>
<div class="block">An interface for tokenizing a given input into valid JSON tokens</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJParser.html#storeArrayTransformer-java.lang.Class-java.lang.Class-java.lang.String-java.lang.Class...-">storeArrayTransformer(Class<?>, Class<?>, String, Class<?>...)</a></span> - Method in class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJParser.html" title="class in io.github.utk003.json.ooj">OOJParser</a></dt>
<dd>
<div class="block">Stores the specified JSON-array-to-class transformer.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONString.html#STRING">STRING</a></span> - Variable in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONString.html" title="class in io.github.utk003.json.traditional.node">JSONString</a></dt>
<dd>
<div class="block">A publicly accessible reference to the <code>String</code> this <code>JSONString</code> represents.</div>
</dd>
</dl>
<a name="I:T">
<!-- -->
</a>
<h2 class="title">T</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJTranslator.JSONValueStreamer.html#tokensPassed--">tokensPassed()</a></span> - Method in class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJTranslator.JSONValueStreamer.html" title="class in io.github.utk003.json.ooj">OOJTranslator.JSONValueStreamer</a></dt>
<dd>
<div class="block">Returns the number of tokens that have been returned so far</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/scanner/JSONScanner.html#tokensPassed--">tokensPassed()</a></span> - Method in class io.github.utk003.json.scanner.<a href="io/github/utk003/json/scanner/JSONScanner.html" title="class in io.github.utk003.json.scanner">JSONScanner</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/scanner/Scanner.html#tokensPassed--">tokensPassed()</a></span> - Method in interface io.github.utk003.json.scanner.<a href="io/github/utk003/json/scanner/Scanner.html" title="interface in io.github.utk003.json.scanner">Scanner</a></dt>
<dd>
<div class="block">Returns the number of tokens that have been returned so far</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/scanner/JSONScanner.html#toString--">toString()</a></span> - Method in class io.github.utk003.json.scanner.<a href="io/github/utk003/json/scanner/JSONScanner.html" title="class in io.github.utk003.json.scanner">JSONScanner</a></dt>
<dd>
<div class="block">Returns the current line number and column of this <code>JSONScanner</code></div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONArray.html#toString--">toString()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONArray.html" title="class in io.github.utk003.json.traditional.node">JSONArray</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONNumber.html#toString--">toString()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONNumber.html" title="class in io.github.utk003.json.traditional.node">JSONNumber</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONObject.html#toString--">toString()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONObject.html" title="class in io.github.utk003.json.traditional.node">JSONObject</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONPrimitive.html#toString--">toString()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONPrimitive.html" title="class in io.github.utk003.json.traditional.node">JSONPrimitive</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONString.html#toString--">toString()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONString.html" title="class in io.github.utk003.json.traditional.node">JSONString</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#toString--">toString()</a></span> - Method in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">This method should be implemented by all subclasses.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/ooj/OOJTranslator.html#translateRecursive-io.github.utk003.json.ooj.OOJParser-io.github.utk003.json.traditional.node.JSONValue-java.lang.Class-">translateRecursive(OOJParser, JSONValue, Class<T>)</a></span> - Static method in class io.github.utk003.json.ooj.<a href="io/github/utk003/json/ooj/OOJTranslator.html" title="class in io.github.utk003.json.ooj">OOJTranslator</a></dt>
<dd>
<div class="block">Recursively translates the given JSON tree rooted at the
<code>root</code> argument using the given <a href="io/github/utk003/json/ooj/OOJParser.html" title="class in io.github.utk003.json.ooj"><code>OOJParser</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.html#TYPE">TYPE</a></span> - Variable in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.html" title="class in io.github.utk003.json.traditional.node">JSONValue</a></dt>
<dd>
<div class="block">This <code>JSONValue</code>'s type (see <a href="io/github/utk003/json/traditional/node/JSONValue.ValueType.html" title="enum in io.github.utk003.json.traditional.node"><code>JSONValue.ValueType</code></a>)</div>
</dd>
</dl>
<a name="I:V">
<!-- -->
</a>
<h2 class="title">V</h2>
<dl>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONPrimitive.html#VALUE">VALUE</a></span> - Variable in class io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONPrimitive.html" title="class in io.github.utk003.json.traditional.node">JSONPrimitive</a></dt>
<dd>
<div class="block">A publicly accessible reference to this primitive.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.ValueType.html#valueOf-java.lang.String-">valueOf(String)</a></span> - Static method in enum io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.ValueType.html" title="enum in io.github.utk003.json.traditional.node">JSONValue.ValueType</a></dt>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</dd>
<dt><span class="memberNameLink"><a href="io/github/utk003/json/traditional/node/JSONValue.ValueType.html#values--">values()</a></span> - Static method in enum io.github.utk003.json.traditional.node.<a href="io/github/utk003/json/traditional/node/JSONValue.ValueType.html" title="enum in io.github.utk003.json.traditional.node">JSONValue.ValueType</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</dd>
</dl>
<a href="#I:A">A</a> <a href="#I:C">C</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:J">J</a> <a href="#I:K">K</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:V">V</a> </div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><div class="contentContainer big-links"> <h3>Quick Links:</h3> <a href="/" target="_top">Website Homepage</a><br/> <a href="/JSON-Parser" target="_top">Project Homepage</a><br/> <a href="https://github.com/utk003/JSON-Parser" target="_top">Project Github</a><br/> <br/> Copyright © <span class="year-span">2020</span> Utkarsh Priyam. All rights reserved. </div> <script src="/scripts/copyright.js"></script> <link href="/css/misc.css" rel="stylesheet"></small></p>
</body>
</html>
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<!-- Mirrored from html.it-rays.net/superfine/assets/revolution/fonts/pe-icon-7-stroke/css/ by HTTrack Website Copier/3.x [XR&CO'2014], Sun, 08 May 2016 19:00:53 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=ISO-8859-1" /><!-- /Added by HTTrack -->
<head>
<title>Index of /superfine/assets/revolution/fonts/pe-icon-7-stroke/css</title>
</head>
<body>
<h1>Index of /superfine/assets/revolution/fonts/pe-icon-7-stroke/css</h1>
<ul><li><a href="../index.html"> Parent Directory</a></li>
<li><a href="helper.css"> helper.css</a></li>
<li><a href="index-2.html"> index.php</a></li>
<li><a href="pe-icon-7-stroke.css"> pe-icon-7-stroke.css</a></li>
</ul>
<address>Apache/2.2.24 (Unix) mod_hive/5.0 mod_ssl/2.2.24 OpenSSL/1.0.0-fips mod_auth_passthrough/2.1 mod_bwlimited/1.4 mod_fastcgi/2.4.6 mod_fcgid/2.3.6 Server at html.it-rays.net Port 80</address>
</body>
<!-- Mirrored from html.it-rays.net/superfine/assets/revolution/fonts/pe-icon-7-stroke/css/ by HTTrack Website Copier/3.x [XR&CO'2014], Sun, 08 May 2016 19:00:54 GMT -->
</html>
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="">
<meta name="author" content="">
<title>Recipe Search</title>
<!-- Bootstrap core CSS -->
<link href="vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet">
<!-- Custom fonts for this template -->
<link href="vendor/fontawesome-free/css/all.min.css" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Varela+Round" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Nunito:200,200i,300,300i,400,400i,600,600i,700,700i,800,800i,900,900i" rel="stylesheet">
<!-- Custom styles for this template -->
<link href="css/grayscale.min.css" rel="stylesheet">
</head>
<body id="page-top">
<!-- Navigation -->
<nav class="navbar navbar-expand-lg navbar-light fixed-top" id="mainNav">
<div class="container">
<a class="navbar-brand js-scroll-trigger" href="index.html">Home</a>
<button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarResponsive" aria-controls="navbarResponsive" aria-expanded="false" aria-label="Toggle navigation">
Menu
<i class="fas fa-bars"></i>
</button>
<div class="collapse navbar-collapse" id="navbarResponsive">
<ul class="navbar-nav ml-auto">
<!-- <li class="nav-item">
<a class="nav-link js-scroll-trigger" href="#about">About</a>
</li> -->
<li class="nav-item dropdown">
<a class="nav-link dropdown-toggle" href="#" id="navbarDropdownBlog" data-toggle="dropdown"
aria-haspopup="true" aria-expanded="false">
Projects
</a>
<div class="dropdown-menu dropdown-menu-right" aria-labelledby="navbarDropdownBlog">
<a class="dropdown-item" href="ISSTracker.html">International Space Station Tracker</a>
<a class="dropdown-item" href="textAdventure.html">Text Adventure Game</a>
<a class="dropdown-item" href="groceryList.html">Dynamic Grocery List</a>
<a class="dropdown-item" href="userScience.html">User Science Blog</a>
<a class="dropdown-item" href="index.html">Home</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link js-scroll-trigger" href="#projects">Explanation</a>
</li>
<li class="nav-item">
<a class="nav-link js-scroll-trigger" href="#signup">Contact</a>
</li>
</ul>
</div>
</div>
</nav>
<!-- Header -->
<header class="masthead">
<div class="container d-flex h-100 align-items-center">
<div class="mx-auto text-center">
<h1 class="mx-auto my-0 text-uppercase">Recipe Search</h1>
<h2 class="text-white-50 mx-auto mt-2 mb-5">Let's Get Cooking!</h2>
<!--update button to go to live site-->
<!-- <a href="#about" class="btn btn-primary js-scroll-trigger">See it Live</a> -->
<a href="https://natemeinhold.com/recipe-search/#/" class="btn btn-primary js-scroll-trigger" >See Live</a>
<a href="https://github.com/NateMeinhold/recipe-search" class="btn btn-primary js-scroll-trigger" >See Code</a>
</div>
</div>
</header>
<!-- About Section -->
<!-- <section id="about" class="about-section text-center">
<div class="container">
<div class="row">
<div class="col-lg-8 mx-auto">
<h2 class="text-white mb-4">This is where my personal statement will go</h2>
<p class="text-white-50">Personal statement placeholder
<a href="http://startbootstrap.com/template-overviews/grayscale/">the preview page</a></p>
</div>
</div>
<img src="" class="img-fluid" alt="">
</div>
</section> -->
<!-- Projects Section -->
<section id="projects" class="projects-section bg-light">
<div class="container">
<!-- Featured Project Row-->
<div class="row align-items-center no-gutters mb-4 mb-lg-5">
<div class="col-xl-8 col-lg-7">
<img class="img-fluid mb-3 mb-lg-0" src="img/recipeSearch1.JPG" alt="This is where the project picture goes">
</div>
<div class="col-xl-4 col-lg-5">
<div class="featured-text text-center text-lg-left">
<h4>The Goal</h4>
<p class="text-black-50 mb-0">Make an app to help a user locate a recipe based on an ingredient they already have.</p>
</div>
</div>
</div>
<!-- Project One Row -->
<div class="row justify-content-center no-gutters mb-5 mb-lg-0">
<!-- <div class="col-lg-6">
<img class="img-fluid" src="img/demo-image-01.jpg" alt="">
</div> -->
<div class="col-lg-20">
<div class="bg-black text-center h-100 project">
<div class="d-flex h-100">
<div class="project-text w-100 my-auto text-center text-lg-left">
<h4 class="text-white">The Method:</h4>
<p class="mb-0 text-white-50">I began with a blank vue.js template and built out from there. Once I knew how many vues I would need, the project began to fall into place.
</p><br>
<p class="mb-0 text-white-50">Once the API call was set up and retrieving data, then the project started to move along more rapidly. It was very exciting to see the data begin to appear on the page.
</p><br>
<p class="mb-0 text-white-50">
The result was a multi-vue app that utilized two API calls in order to bring the user recipe information.</p><br>
<h4 class="text-white">Unexpected Challenges:</h4>
<p class="mb-0 text-white-50">
Working with the API meant that I was contrained by the information the API was able to provide. It took some getting used to, but I was able to present the data on the page how I wanted it to be presented; neatly packaged and with images.</p>
<hr class="d-none d-lg-block mb-0 ml-0">
</div>
</div>
</div>
</div>
</div>
<!-- Featured Project Row-->
<div class="row align-items-center no-gutters mb-4 mb-lg-5">
<div class="col-xl-8 col-lg-7">
<img class="img-fluid mb-3 mb-lg-0" src="img/recipeSearch2.JPG" alt="This is where the project picture goes">
</div>
<div class="col-xl-4 col-lg-5">
<div class="featured-text text-center text-lg-left">
<h4>This is where the information starts about the project</h4>
<p class="text-black-50 mb-0">basic info about the capstone with a link to the detailed information</p>
</div>
</div>
</div>
<!-- Project Two Row -->
<!-- <div class="row justify-content-center no-gutters">
<div class="col-lg-6">
<img class="img-fluid" src="img/demo-image-02.jpg" alt="">
</div>
<div class="col-lg-6 order-lg-first">
<div class="bg-black text-center h-100 project">
<div class="d-flex h-100">
<div class="project-text w-100 my-auto text-center text-lg-right">
<h4 class="text-white">A Smaller Project</h4>
<p class="mb-0 text-white-50">Another example of a project with its respective description. These sections work well responsively as well, try this theme on a small screen!</p>
<hr class="d-none d-lg-block mb-0 mr-0">
</div>
</div>
</div>
</div>
</div> -->
<!-- Project Three Row -->
<!-- <div class="row justify-content-center no-gutters mb-5 mb-lg-0">
<div class="col-lg-6">
<img class="img-fluid" src="img/demo-image-01.jpg" alt="">
</div>
<div class="col-lg-6">
<div class="bg-black text-center h-100 project">
<div class="d-flex h-100">
<div class="project-text w-100 my-auto text-center text-lg-left">
<h4 class="text-white">A Smaller Project</h4>
<p class="mb-0 text-white-50">An example of where you can put an image of a project, or anything else, along with a description.</p>
<hr class="d-none d-lg-block mb-0 ml-0">
</div>
</div>
</div>
</div>
</div> -->
<!-- Project Four Row -->
<!-- <div class="row justify-content-center no-gutters">
<div class="col-lg-6">
<img class="img-fluid" src="img/demo-image-02.jpg" alt="">
</div>
<div class="col-lg-6 order-lg-first">
<div class="bg-black text-center h-100 project">
<div class="d-flex h-100">
<div class="project-text w-100 my-auto text-center text-lg-right">
<h4 class="text-white">A Smaller Project</h4>
<p class="mb-0 text-white-50">Another example of a project with its respective description. These sections work well responsively as well, try this theme on a small screen!</p>
<hr class="d-none d-lg-block mb-0 mr-0">
</div>
</div>
</div>
</div>
</div> -->
</div>
</section>
<!-- Signup Section -->
<section id="signup" class="signup-section">
<div class="container">
<div class="social d-flex justify-content-center">
<a href="#" class="mx-2">
<i class="fab fa-twitter"></i>
</a>
<a href="#" class="mx-2">
<i class="fab fa-facebook-f"></i>
</a>
<a href="#" class="mx-2">
<i class="fab fa-github"></i>
</a>
</div>
<!-- <div class="row">
<div class="col-md-10 col-lg-8 mx-auto text-center">
<i class="far fa-paper-plane fa-2x mb-2 text-white"></i>
<h2 class="text-white mb-5">Subscribe to receive updates!</h2>
<form class="form-inline d-flex">
<input type="email" class="form-control flex-fill mr-0 mr-sm-2 mb-3 mb-sm-0" id="inputEmail" placeholder="Enter email address...">
<button type="submit" class="btn btn-primary mx-auto">Subscribe</button>
</form>
</div>
</div> -->
</div>
</section>
<!-- Contact Section -->
<!-- <section class="contact-section bg-black">
<div class="container">
<div class="row">
<div class="col-md-4 mb-3 mb-md-0">
<div class="card py-4 h-100">
<div class="card-body text-center">
<i class="fas fa-map-marked-alt text-primary mb-2"></i>
<h4 class="text-uppercase m-0">Address</h4>
<hr class="my-4">
<div class="small text-black-50">4923 Market Street, Orlando FL</div>
</div>
</div>
</div>
<div class="col-md-4 mb-3 mb-md-0">
<div class="card py-4 h-100">
<div class="card-body text-center">
<i class="fas fa-envelope text-primary mb-2"></i>
<h4 class="text-uppercase m-0">Email</h4>
<hr class="my-4">
<div class="small text-black-50">
<a href="#">hello@yourdomain.com</a>
</div>
</div>
</div>
</div>
<div class="col-md-4 mb-3 mb-md-0">
<div class="card py-4 h-100">
<div class="card-body text-center">
<i class="fas fa-mobile-alt text-primary mb-2"></i>
<h4 class="text-uppercase m-0">Phone</h4>
<hr class="my-4">
<div class="small text-black-50">+1 (555) 902-8832</div>
</div>
</div>
</div>
</div> -->
<!-- <div class="social d-flex justify-content-center">
<a href="#" class="mx-2">
<i class="fab fa-twitter"></i>
</a>
<a href="#" class="mx-2">
<i class="fab fa-facebook-f"></i>
</a>
<a href="#" class="mx-2">
<i class="fab fa-github"></i>
</a>
</div>
</div>
</section>-->
<!-- Footer -->
<footer class="bg-black small text-center text-white-50">
<div class="container">
Copyright © Nate Meinhold 2019
</div>
</footer>
<!-- Bootstrap core JavaScript -->
<script src="vendor/jquery/jquery.min.js"></script>
<script src="vendor/bootstrap/js/bootstrap.bundle.min.js"></script>
<!-- Plugin JavaScript -->
<script src="vendor/jquery-easing/jquery.easing.min.js"></script>
<!-- Custom scripts for this template -->
<script src="js/grayscale.min.js"></script>
</body>
</html> |
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="pt"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../../../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../../../jacoco-resources/report.gif" type="image/gif"/><title>PreambleEditor.StoreFieldAction</title><script type="text/javascript" src="../../../jacoco-resources/sort.js"></script></head><body onload="initialSort(['breadcrumb'])"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../../../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../../../index.html" class="el_report">java (11/05/2018 16:12:58)</a> > <a href="../../index.html" class="el_group">JabRef</a> > <a href="../index.html" class="el_bundle">src/main/java</a> > <a href="index.html" class="el_package">org.jabref.gui</a> > <span class="el_class">PreambleEditor.StoreFieldAction</span></div><h1>PreambleEditor.StoreFieldAction</h1><table class="coverage" cellspacing="0" id="coveragetable"><thead><tr><td class="sortable" id="a" onclick="toggleSort(this)">Element</td><td class="down sortable bar" id="b" onclick="toggleSort(this)">Missed Instructions</td><td class="sortable ctr2" id="c" onclick="toggleSort(this)">Cov.</td><td class="sortable bar" id="d" onclick="toggleSort(this)">Missed Branches</td><td class="sortable ctr2" id="e" onclick="toggleSort(this)">Cov.</td><td class="sortable ctr1" id="f" onclick="toggleSort(this)">Missed</td><td class="sortable ctr2" id="g" onclick="toggleSort(this)">Cxty</td><td class="sortable ctr1" id="h" onclick="toggleSort(this)">Missed</td><td class="sortable ctr2" id="i" onclick="toggleSort(this)">Lines</td><td class="sortable ctr1" id="j" onclick="toggleSort(this)">Missed</td><td class="sortable ctr2" id="k" onclick="toggleSort(this)">Methods</td></tr></thead><tfoot><tr><td>Total</td><td class="bar">72 of 72</td><td class="ctr2">0%</td><td class="bar">4 of 4</td><td class="ctr2">0%</td><td class="ctr1">4</td><td class="ctr2">4</td><td class="ctr1">14</td><td class="ctr2">14</td><td class="ctr1">2</td><td class="ctr2">2</td></tr></tfoot><tbody><tr><td id="a0"><a href="PreambleEditor.java.html#L151" class="el_method">actionPerformed(ActionEvent)</a></td><td class="bar" id="b0"><img src="../../../jacoco-resources/redbar.gif" width="120" height="10" title="61" alt="61"/></td><td class="ctr2" id="c0">0%</td><td class="bar" id="d0"><img src="../../../jacoco-resources/redbar.gif" width="120" height="10" title="4" alt="4"/></td><td class="ctr2" id="e0">0%</td><td class="ctr1" id="f0">3</td><td class="ctr2" id="g0">3</td><td class="ctr1" id="h0">10</td><td class="ctr2" id="i0">10</td><td class="ctr1" id="j0">1</td><td class="ctr2" id="k0">1</td></tr><tr><td id="a1"><a href="PreambleEditor.java.html#L144" class="el_method">PreambleEditor.StoreFieldAction(PreambleEditor)</a></td><td class="bar" id="b1"><img src="../../../jacoco-resources/redbar.gif" width="21" height="10" title="11" alt="11"/></td><td class="ctr2" id="c1">0%</td><td class="bar" id="d1"/><td class="ctr2" id="e1">n/a</td><td class="ctr1" id="f1">1</td><td class="ctr2" id="g1">1</td><td class="ctr1" id="h1">4</td><td class="ctr2" id="i1">4</td><td class="ctr1" id="j1">1</td><td class="ctr2" id="k1">1</td></tr></tbody></table><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.7.9.201702052155</span>java (11/05/2018 16:12:58)</div></body></html> |
<!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><link rel="stylesheet" type="text/css" href="style.css" /><script type="text/javascript" src="highlight.js"></script></head><body><pre><span class="hs-pragma">{-# OPTIONS_HADDOCK not-home #-}</span><span>
</span><a name="line-2"></a><span class="hs-pragma">{-# LANGUAGE RankNTypes #-}</span><span>
</span><a name="line-3"></a><span class="hs-keyword">module</span><span> </span><span class="hs-identifier">Hedgehog.Internal.HTraversable</span><span> </span><span class="hs-special">(</span><span>
</span><a name="line-4"></a><span> </span><a href="Hedgehog.Internal.HTraversable.html#HTraversable"><span class="hs-identifier hs-type">HTraversable</span></a><span class="hs-special">(</span><span class="hs-glyph">..</span><span class="hs-special">)</span><span>
</span><a name="line-5"></a><span> </span><span class="hs-special">)</span><span> </span><span class="hs-keyword">where</span><span>
</span><a name="line-6"></a><span>
</span><a name="line-7"></a><span>
</span><a name="line-8"></a><span class="hs-comment">-- | Higher-order traversable functors.</span><span>
</span><a name="line-9"></a><span class="hs-comment">--</span><span>
</span><a name="line-10"></a><span class="hs-comment">-- This is used internally to make symbolic variables concrete given an 'Environment'.</span><span>
</span><a name="line-11"></a><span class="hs-comment">--</span><span>
</span><a name="line-12"></a><span class="hs-keyword">class</span><span> </span><a name="HTraversable"><a href="Hedgehog.Internal.HTraversable.html#HTraversable"><span class="hs-identifier">HTraversable</span></a></a><span> </span><a name="local-6989586621679064409"><a href="#local-6989586621679064409"><span class="hs-identifier">t</span></a></a><span> </span><span class="hs-keyword">where</span><span>
</span><a name="line-13"></a><span> </span><a name="htraverse"><a href="Hedgehog.Internal.HTraversable.html#htraverse"><span class="hs-identifier">htraverse</span></a></a><span> </span><span class="hs-glyph">::</span><span> </span><span class="hs-identifier hs-type">Applicative</span><span> </span><a href="#local-6989586621679064410"><span class="hs-identifier hs-type">f</span></a><span> </span><span class="hs-glyph">=></span><span> </span><span class="hs-special">(</span><span class="hs-keyword">forall</span><span> </span><a name="local-6989586621679064413"><a href="#local-6989586621679064413"><span class="hs-identifier">a</span></a></a><span class="hs-operator">.</span><span> </span><a href="#local-6989586621679064411"><span class="hs-identifier hs-type">g</span></a><span> </span><a href="#local-6989586621679064413"><span class="hs-identifier hs-type">a</span></a><span> </span><span class="hs-glyph">-></span><span> </span><a href="#local-6989586621679064410"><span class="hs-identifier hs-type">f</span></a><span> </span><span class="hs-special">(</span><a href="#local-6989586621679064412"><span class="hs-identifier hs-type">h</span></a><span> </span><a href="#local-6989586621679064413"><span class="hs-identifier hs-type">a</span></a><span class="hs-special">)</span><span class="hs-special">)</span><span> </span><span class="hs-glyph">-></span><span> </span><a href="#local-6989586621679064409"><span class="hs-identifier hs-type">t</span></a><span> </span><a href="#local-6989586621679064411"><span class="hs-identifier hs-type">g</span></a><span> </span><span class="hs-glyph">-></span><span> </span><a href="#local-6989586621679064410"><span class="hs-identifier hs-type">f</span></a><span> </span><span class="hs-special">(</span><a href="#local-6989586621679064409"><span class="hs-identifier hs-type">t</span></a><span> </span><a href="#local-6989586621679064412"><span class="hs-identifier hs-type">h</span></a><span class="hs-special">)</span><span>
</span><a name="line-14"></a></pre></body></html> |
<!DOCTYPE html>
<html lang="zh=TW">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, initial-scale=1.0, user-scalable=no">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="theme-color" content="#ffffff">
<!--上線後刪除此段Meta與註解-->
<meta name="robots" content="noindex, nofollow,noarchive,nosnippet,noimageindex,noodp">
<!-- End 測試站防止被爬蟲搜尋-->
<title>抽紅包 | 棉花田</title>
<!-- Bootstrap core CSS -->
<link href="/assets/bootstrap/css/bootstrap.css" rel="stylesheet">
<link href="/assets/css/animate.css" rel="stylesheet">
<link href="/assets/libs/datepicker/css/datepicker.min.css" rel="stylesheet">
<!-- Custom styles for this template -->
<link href="/assets/css/index.css?1.0" rel="stylesheet">
<link href="/assets/css/index_mobel.css?1.0" rel="stylesheet">
</head>
<body>
{include file="header" /}
<style>
.ad_title1 {
background: rgba(255,231,113,1);
font-size: 23px;
font-weight: bold;
line-height: 36px;
color: rgba(171,38,52,1);
margin-top: 36px;
padding: 20px 10px;
}
</style>
<div class="main-wrapper" id="app">
<div class="banner-wrapper banner">
<img src="/assets/images/banner.png" class="img-fluid" />
<div class="side_float gift_1 wow fadeInUp" data-wow-delay="0.5s"></div>
<div class="side_float gift_2 wow fadeInUp" data-wow-delay="0.6s"></div>
<div class="side_float gift_3 wow fadeInLeft" data-wow-delay="0.7s"></div>
<div class="side_float z_1 wow fadeIn" data-wow-delay="0.6s"></div>
<div class="side_float z_2 wow fadeInDown" data-wow-delay="0.6s"></div>
<div class="side_float z_3 wow zoomIn" data-wow-delay="0.5s"></div>
<div class="side_float z_4 wow zoomIn" data-wow-delay="0.5s"></div>
<div class="side_float z_5 wow slideInDown" data-wow-delay="0.5s">
<!--程式說明 ※上程式後刪除-->
<!--alert-login 為登入前 跳出會員登入畫面-->
<!--scroll-login 為登入後 錨點至下方登錄發票-->
<a href="javascript:void(0);" class="login scroll-login">登錄發票</a>
</div>
</div>
<section class="conner_wrapper" id="redpackage">
<div class="hi_conner_bg pt-5">
<div class="container">
<div class="hi_box">
<h2 class="h-title hi"><img src="/assets/images/hi_tice.png" /> 好運紅包任你抽</h2>
<div class="block prize1">
<div class="red_title">
<h2 class="">共可以抽<span class="b" style="font-size: 8vw;width: 9vw;">{{award}}</span>包紅包，還剩<span class="b r" style="font-size: 8vw;width: 9vw;">{{limit}}</span>次機會</h2>
</div>
<!--程式說明 ※上程式後刪除-->
<!--data-title 為演示 ※上程式後刪除-->
<!--data-z 為演示 ※上程式後刪除-->
<div class="row redb wow fadeIn" data-wow-delay="0.3s">
<div class="col-md-5-5 col-6">
<div @click="cj()" class="p_img" data-title="指定商品加價購" data-z="">
<img src="/assets/images/red.png" />
</div>
</div>
<div class="col-md-5-5 col-6" data-title="現金禮券 30 元" data-z="2">
<div @click="cj()" class="p_img" data-title="現金禮券 30 元" data-z="">
<img src="/assets/images/red.png" />
</div>
</div>
<div class="col-md-5-5 col-6">
<div class="p_img" @click="cj()">
<img src="/assets/images/red.png" />
</div>
</div>
<div class="col-md-5-5 col-6">
<div class="p_img" @click="cj()">
<img src="/assets/images/red.png" />
</div>
</div>
<div class="col-md-5-5 col-6">
<div class="p_img" @click="cj()">
<img src="/assets/images/red.png" />
</div>
</div>
<div class="col-md-5-5 col-6">
<div class="p_img" @click="cj()">
<img src="/assets/images/red.png" />
</div>
</div>
<div class="col-md-5-5 col-6">
<div class="p_img" @click="cj()">
<img src="/assets/images/red.png" />
</div>
</div>
<div class="col-md-5-5 col-6">
<div class="p_img" @click="cj()">
<img src="/assets/images/red.png" />
</div>
</div>
<div class="col-md-5-5 col-6">
<div class="p_img" @click="cj()">
<img src="/assets/images/red.png" />
</div>
</div>
<div class="col-md-5-5 col-6">
<div class="p_img" @click="cj()">
<img src="/assets/images/red.png" />
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<!--登錄demo-->
<div class="modal" id="mobel_demo" data-backdrop="static">
<div class="modal-dialog cottonfeild login " >
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
<img src="/assets/images/close.png" />
</button>
</div>
<div class="modal-body">
<h3 class="model_title">歡迎來到棉花田</h3>
<form>
<div class="form-group">
<i class="b-icon phone"><img src="/assets/images/phone.png" /></i>
<input type="text" name="phone" class="form-control form-control-lg" placeholder="請輸入手機號碼" />
</div>
<div class="form-group">
<i class="b-icon password"><img src="/assets/images/password.png" /></i>
<input type="text" name="phone" class="form-control form-control-lg" placeholder="會員卡號或店號" />
</div>
<div class="form-group">
<button type="button" class="btn btn-block btn-lg btn-alert">登入</button>
</div>
</form>
<div class="modal-header"></div>
</div>
</div>
</div>
</div>
<!--抽獎demo-->
<div class="modal fade" id="luck" data-backdrop="static">
<div class="modal-dialog cottonfeild modal-md modal-dialog-popout " >
<div class="modal-content" id="tc">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
<img src="/assets/images/close.png" />
</button>
</div>
<div class="modal-body">
<h3 class="model_title">恭喜您抽到了<span>{{type.title}}</span></h3>
<img :src="type.img" class="img-fluid" />
<div class="ad_title1" v-if="type.time_limit == 1">尚待資料傳輸中，活動抽獎序號請於隔日中午12時查看!</div>
<h4 class="list"><img src="/assets/images/101.png" width="40" style="margin-right:10px;" />注意事項：</h4>
{{type.desc}}
<h4 class="list"><img src="/assets/images/102.png" width="40" style="margin-right:10px;" />使用方式：</h4>
{{type.used}}
<p> </p>
<div class="row">
<div class="col-6"><button type="button" class="btn btn-block btn-lg btn-again" data-dismiss="modal" aria-label="Close">繼續抽紅包</button></div>
<div class="col-6"><a class="btn btn-block btn-lg btn-alert" href="query.html">查詢中獎紀錄</a></div>
</div>
</div>
</div>
</div>
</div>
<!--注意事項demo-->
<div class="modal fade" id="attention" data-backdrop="static">
<div class="modal-dialog cottonfeild modal-lg modal-dialog-popout" >
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
<img src="/assets/images/close.png" />
</button>
</div>
<div class="modal-body">
<h3 class="model_title">注意事項</h3>
<p>1. 欲參加抽獎活動不同張發票恕不累積發票金額。</p>
<p>2. 本抵用券、兌換券序號使用期限至 2019/2/19，逾期恕無法兌換，每券限使用乙次。</p>
<p>3. 加價購商品序號使用期限至 2019/2/19，逾期恕無法兌換，每券限使用乙次本券須於下壹筆消費使用，恕不兌換現金或找零，也不列入會員消費累積。</p>
<p>4. 本序號券不限門市使用，僅限於棉花田實體門市使用。</p>
<p>5. 本券壹經使用不得退換或要求補發，抵用券/兌換券/加價購商品序號，數量有限，送/售完為止。</p>
<p>6. 基於個人資料保護法保護個資原則，棉花田生機園地絕不外洩參與活動者之個人資料。惟活動者於參加本活動前了解並同意主辦單位於本活動之範圍內，得蒐集、處理及利用本人之個人資料(包括但不限於姓名、e-mail、手機、會員卡號等)。</p>
<p>7. 活動辦法若有未盡事宜，棉花田保有隨時解釋、變更活動辦法與獎品內容，以及暫停、延長、提前終止本活動之權利。並公告於本公司活動網站，將不另行通知。</p>
<p> </p>
<p>與我們聯繫：</p>
<p>客服信箱：sun@oneness.tw。</p>
<p>客服專線：0800-559-588。</p>
<p>服務時間週一 ~ 週五 08:30 ~ 17:30</p>
<div class="modal-header"></div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<p>版權所有 棉花田生機園地股份有限公司</p>
<p>© 2019 Cotton Field Organic Co.,Ltd. All Rights Reserved</p>
<p>客服專線：0800-559-588</p>
</div>
</footer>
<script type="text/javascript" src="/assets/js/vendor/jquery-3.2.1.min.js"></script>
<script type="text/javascript" src="/assets/bootstrap/js/popper.min.js"></script>
<script type="text/javascript" src="/assets/bootstrap/js/bootstrap.min.js"></script>
<script type="text/javascript" src="/assets/libs/datepicker/js/datepicker.min.js"></script>
<script type="text/javascript" src="/assets/libs/datepicker/js/datepicker.zh.min.js"></script>
<script type="text/javascript" src="/assets/js/wow.min.js"></script>
<script src="https://cdn.staticfile.org/vue/2.4.2/vue.min.js">
</script>
<script type="text/javascript" src="/assets/js/all.js?1.0"></script>
{include file="footer" /}
<script>
$(document).ready(function(){
$('.datepicker-here').datepicker({ autoClose:true, });
})
var app = new Vue({
el: '#app',
data: {
type: '',
award:{$award},
limit:{$limit}
},
mounted: function () {
},
methods: {
cj(){
$.ajax({
// async: true,
type: 'POST',
dataType: 'json',
data: {},
url: '{:url('index/award')}',
success: function (res) {
if(res.code==1){
app.type=res.data.type;
app.limit -=1;
$('#luck').modal('show');
}else {
alert(res.msg);
document.location.href='{:url('index/red_env')}';
// return false;
// document.getElementById('luck').style.visibility="hidden";
}
console.log(res);
// app.column = res.data[0];
},
error: function (res) {
console.log(res);
}
});
}
},
})
// $(function () {
// $('.p_img').click(function () {
// $.ajax({
// // async: true,
// type: 'POST',
// dataType: 'json',
// data: {},
// url: '{:url('index/award')}',
// success: function (res) {
// if(res.code==1){
//
// }else {
// alert(res.msg);
// }
// console.log(res);
// // app.column = res.data[0];
// },
// error: function (res) {
// console.log(res);
// }
// });
// })
// })
</script>
</body>
</html> |
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>References: net/http.ServeContent</title>
<link href="../../css/light-v0.3.6.css" rel="stylesheet">
<script src="../../jvs/golds-v0.3.6.js"></script>
<body onload="onPageLoad()"><div>
<pre><code><span style="font-size:x-large;">func <b><a href="../../pkg/net/http.html">net/http</a>.<a href="../../src/net/http/fs.go.html#line-192">ServeContent</a></b></span>
<span class="title">one use</span>
net/http (current package)
<a href="../../src/net/http/fs.go.html#line-192">fs.go#L192</a>: func <b>ServeContent</b>(w ResponseWriter, req *Request, name string, modtime time.Time, content io.ReadSeeker) {
</code></pre><pre id="footer">
<table><tr><td><img src="../../png/go101-twitter.png"></td>
<td>The pages are generated with <a href="https://go101.org/article/tool-golds.html"><b>Golds</b></a> <i>v0.3.6</i>. (GOOS=linux GOARCH=amd64)
<b>Golds</b> is a <a href="https://go101.org">Go 101</a> project developed by <a href="https://tapirgames.com">Tapir Liu</a>.
PR and bug reports are welcome and can be submitted to <a href="https://github.com/go101/golds">the issue list</a>.
Please follow <a href="https://twitter.com/go100and1">@Go100and1</a> (reachable from the left QR code) to get the latest news of <b>Golds</b>.</td></tr></table></pre> |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>extends \ Language (API) \ Processing 2+</title>
<link rel="icon" href="/favicon.ico" type="image/x-icon" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="Author" content="Processing Foundation" />
<meta name="Publisher" content="Processing Foundation" />
<meta name="Keywords" content="Processing, Sketchbook, Programming, Coding, Code, Art, Design" />
<meta name="Description" content="Processing is a flexible software sketchbook and a language for learning how to code within the context of the visual arts. Since 2001, Processing has promoted software literacy within the visual arts and visual literacy within technology." />
<meta name="Copyright" content="All contents copyright the Processing Foundation, Ben Fry, Casey Reas, and the MIT Media Laboratory" />
<script src="javascript/modernizr-2.6.2.touch.js" type="text/javascript"></script>
<link href="css/style.css" rel="stylesheet" type="text/css" />
</head>
<body id="Langauge-en" onload="" >
<!-- ==================================== PAGE ============================ -->
<div id="container">
<!-- ==================================== HEADER ============================ -->
<div id="ribbon">
<ul class="left">
<li class="highlight"><a href="http://processing.org/">Processing</a></li>
<li><a href="http://p5js.org/">p5.js</a></li>
<li><a href="http://py.processing.org/">Processing.py</a></li>
</ul>
<ul class="right">
<li><a href="https://processingfoundation.org/">Processing Foundation</a></li>
</ul>
<div class="clear"></div>
</div>
<div id="header">
<a href="/" title="Back to the Processing cover."><div class="processing-logo no-cover" alt="Processing cover"></div></a>
<form name="search" method="get" action="//www.google.com/search">
<p><input type="hidden" name="as_sitesearch" value="processing.org" />
<input type="text" name="as_q" value="" size="20" class="text" />
<input type="submit" value=" " /></p>
</form>
</div>
<a id="TOP" name="TOP"></a>
<div id="navigation">
<div class="navBar" id="mainnav">
<a href="index.html" class='active'>Language</a><br>
<a href="libraries/index.html" >Libraries</a><br>
<a href="tools/index.html">Tools</a><br>
<a href="environment/index.html">Environment</a><br>
</div>
<script> document.querySelectorAll(".processing-logo")[0].className = "processing-logo"; </script>
</div>
<!-- ==================================== CONTENT - Headers ============================ -->
<div class="content">
<p class="ref-notice">This reference is for Processing 3.0+. If you have a previous version, use the reference included with your software in the Help menu. If you see any errors or have suggestions, <a href="https://github.com/processing/processing-docs/issues?state=open">please let us know</a>. If you prefer a more technical reference, visit the <a href="http://processing.github.io/processing-javadocs/core/">Processing Core Javadoc</a> and <a href="http://processing.github.io/processing-javadocs/libraries/">Libraries Javadoc</a>.</p>
<table cellpadding="0" cellspacing="0" border="0" class="ref-item">
<tr class="name-row">
<th scope="row">Name</th>
<td><h3>extends</h3></td>
</tr>
<tr class="">
<tr class=""><th scope="row">Examples</th><td><div class="example"><pre >
DrawDot dd1 = new DrawDot(50, 80);
void setup() {
size(200, 200);
}
void draw() {
dd1.display();
}
class Dot {
int xpos, ypos;
}
class DrawDot extends Dot {
DrawDot(int x, int y) {
xpos = x;
ypos = y;
}
void display() {
ellipse(xpos, ypos, 200, 200);
}
}
</pre></div>
</td></tr>
<tr class="">
<th scope="row">Description</th>
<td>
Allows a new class to <em>inherit</em> the methods and data fields (variables and constants) from an existing class. In code, state the name of the new class, followed by the keyword <b>extends</b> and the name of the <i>base class</i>. The concept of inheritance is one of the fundamental principles of object oriented programming.<br />
<br />
Note that in Java, and therefore also Processing, you cannot extend a class more than once. Instead, see <b>implements</b>.
</td>
</tr>
<tr class=""><th scope="row">Related</th><td><a class="code" href="class.html">class</a><br />
<a class="code" href="super.html">super</a><br />
<a class="code" href="implements.html">implements</a><br /></td></tr>
</table>
Updated on February 10, 2016 00:49:49am EST<br /><br />
<!-- Creative Commons License -->
<div class="license">
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border: none" src="http://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a>
</div>
<!--
<?xpacket begin='' id=''?>
<x:xmpmeta xmlns:x='adobe:ns:meta/'>
<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'>
<rdf:Description rdf:about=''
xmlns:xapRights='http://ns.adobe.com/xap/1.0/rights/'>
<xapRights:Marked>True</xapRights:Marked>
</rdf:Description>
<rdf:Description rdf:about=''
xmlns:xapRights='http://ns.adobe.com/xap/1.0/rights/'
>
<xapRights:UsageTerms>
<rdf:Alt>
<rdf:li xml:lang='x-default' >This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.</rdf:li>
<rdf:li xml:lang='en' >This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.</rdf:li>
</rdf:Alt>
</xapRights:UsageTerms>
</rdf:Description>
<rdf:Description rdf:about=''
xmlns:cc='http://creativecommons.org/ns#'>
<cc:license rdf:resource='http://creativecommons.org/licenses/by-nc-sa/4.0/'/>
</rdf:Description>
</rdf:RDF>
</x:xmpmeta>
<?xpacket end='r'?>
-->
</div>
<!-- ==================================== FOOTER ============================ -->
<div id="footer">
<div id="copyright">Processing is an open project intiated by <a href="http://benfry.com/">Ben Fry</a> and <a href="http://reas.com">Casey Reas</a>. It is developed by a <a href="http://processing.org/about/people/">team of volunteers</a>.</div>
<div id="colophon">
<a href="copyright.html">© Info</a>
</div>
</div>
</div>
<script src="javascript/jquery-1.9.1.min.js"></script>
<script src="javascript/site.js" type="text/javascript"></script>
</body>
</html>
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Represents the authority component of a URI."><meta name="keywords" content="rust, rustlang, rust-lang, Authority"><title>Authority in http::uri - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script>
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../http/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../../http/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">Authority</a></h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.as_str">as_str</a><a href="#method.from_maybe_shared">from_maybe_shared</a><a href="#method.from_static">from_static</a><a href="#method.host">host</a><a href="#method.port">port</a><a href="#method.port_u16">port_u16</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-AsRef%3Cstr%3E">AsRef<str></a><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Display">Display</a><a href="#impl-Eq">Eq</a><a href="#impl-FromStr">FromStr</a><a href="#impl-Hash">Hash</a><a href="#impl-PartialEq%3C%26%27a%20str%3E">PartialEq<&'a str></a><a href="#impl-PartialEq%3CAuthority%3E">PartialEq<Authority></a><a href="#impl-PartialEq%3CString%3E">PartialEq<String></a><a href="#impl-PartialEq%3Cstr%3E">PartialEq<str></a><a href="#impl-PartialOrd%3C%26%27a%20str%3E">PartialOrd<&'a str></a><a href="#impl-PartialOrd%3CAuthority%3E">PartialOrd<Authority></a><a href="#impl-PartialOrd%3CString%3E">PartialOrd<String></a><a href="#impl-PartialOrd%3Cstr%3E">PartialOrd<str></a><a href="#impl-TryFrom%3C%26%27a%20%5Bu8%5D%3E">TryFrom<&'a [u8]></a><a href="#impl-TryFrom%3C%26%27a%20str%3E">TryFrom<&'a str></a><a href="#impl-TryFrom%3CString%3E">TryFrom<String></a><a href="#impl-TryFrom%3CVec%3Cu8%2C%20Global%3E%3E">TryFrom<Vec<u8, Global>></a></div><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-ToString">ToString</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2 class="location">In <a href="../index.html">http</a>::<wbr><a href="index.html">uri</a></h2><div id="sidebar-vars" data-name="Authority" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../http/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div>
<input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Struct <a href="../index.html">http</a>::<wbr><a href="index.html">uri</a>::<wbr><a class="struct" href="#">Authority</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/http/uri/authority.rs.html#13-15" title="goto source code">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust struct"><code>pub struct Authority { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Represents the authority component of a URI.</p>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#17-260" title="goto source code">source</a></div><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_static" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#48-51" title="goto source code">source</a></div><a href="#method.from_static" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.from_static" class="fnname">from_static</a>(src: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</h4></div></summary><div class="docblock"><p>Attempt to convert an <code>Authority</code> from a static string.</p>
<p>This function will not perform any copying, and the string will be
checked if it is empty or contains an invalid character.</p>
<h5 id="panics" class="section-header"><a href="#panics">Panics</a></h5>
<p>This function panics if the argument contains invalid characters or
is empty.</p>
<h5 id="examples" class="section-header"><a href="#examples">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">authority</span> <span class="op">=</span> <span class="ident">Authority::from_static</span>(<span class="string">"example.com"</span>);
<span class="macro">assert_eq!</span>(<span class="ident">authority</span>.<span class="ident">host</span>(), <span class="string">"example.com"</span>);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_maybe_shared" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#57-66" title="goto source code">source</a></div><a href="#method.from_maybe_shared" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.from_maybe_shared" class="fnname">from_maybe_shared</a><T>(src: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.InvalidUri.html" title="struct http::uri::InvalidUri">InvalidUri</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>> + 'static, </span></h4></div></summary><div class="docblock"><p>Attempt to convert a <code>Bytes</code> buffer to a <code>Authority</code>.</p>
<p>This will try to prevent a copy if the type passed is the type used
internally, and will copy the data if it is not.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.host" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#195-197" title="goto source code">source</a></div><a href="#method.host" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.host" class="fnname">host</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></div></summary><div class="docblock"><p>Get the host of this <code>Authority</code>.</p>
<p>The host subcomponent of authority is identified by an IP literal
encapsulated within square brackets, an IPv4 address in dotted- decimal
form, or a registered name. The host subcomponent is <strong>case-insensitive</strong>.</p>
<div class="example-wrap"><pre class="language-notrust"><code>abc://username:password@example.com:123/path/data?key=value&key2=value2#fragid1
|---------|
|
host</code></pre></div><h5 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">authority</span>: <span class="ident">Authority</span> <span class="op">=</span> <span class="string">"example.org:80"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq!</span>(<span class="ident">authority</span>.<span class="ident">host</span>(), <span class="string">"example.org"</span>);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.port" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#234-239" title="goto source code">source</a></div><a href="#method.port" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.port" class="fnname">port</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.Port.html" title="struct http::uri::Port">Port</a><&<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>></h4></div></summary><div class="docblock"><p>Get the port part of this <code>Authority</code>.</p>
<p>The port subcomponent of authority is designated by an optional port
number following the host and delimited from it by a single colon (“:”)
character. It can be turned into a decimal port number with the <code>as_u16</code>
method or as a <code>str</code> with the <code>as_str</code> method.</p>
<div class="example-wrap"><pre class="language-notrust"><code>abc://username:password@example.com:123/path/data?key=value&key2=value2#fragid1
|-|
|
port</code></pre></div><h5 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h5>
<p>Authority with port</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">authority</span>: <span class="ident">Authority</span> <span class="op">=</span> <span class="string">"example.org:80"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">port</span> <span class="op">=</span> <span class="ident">authority</span>.<span class="ident">port</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq!</span>(<span class="ident">port</span>.<span class="ident">as_u16</span>(), <span class="number">80</span>);
<span class="macro">assert_eq!</span>(<span class="ident">port</span>.<span class="ident">as_str</span>(), <span class="string">"80"</span>);</code></pre></div>
<p>Authority without port</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">authority</span>: <span class="ident">Authority</span> <span class="op">=</span> <span class="string">"example.org"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
<span class="macro">assert!</span>(<span class="ident">authority</span>.<span class="ident">port</span>().<span class="ident">is_none</span>());</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.port_u16" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#251-253" title="goto source code">source</a></div><a href="#method.port_u16" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.port_u16" class="fnname">port_u16</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>></h4></div></summary><div class="docblock"><p>Get the port of this <code>Authority</code> as a <code>u16</code>.</p>
<h5 id="example" class="section-header"><a href="#example">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">authority</span>: <span class="ident">Authority</span> <span class="op">=</span> <span class="string">"example.org:80"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq!</span>(<span class="ident">authority</span>.<span class="ident">port_u16</span>(), <span class="prelude-val">Some</span>(<span class="number">80</span>));</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_str" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#257-259" title="goto source code">source</a></div><a href="#method.as_str" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.as_str" class="fnname">as_str</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></div></summary><div class="docblock"><p>Return a str representation of the authority</p>
</div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-AsRef%3Cstr%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#265-269" title="goto source code">source</a></div><a href="#impl-AsRef%3Cstr%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_ref" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#266-268" title="goto source code">source</a></div><a href="#method.as_ref" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html#tymethod.as_ref" class="fnname">as_ref</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Clone" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#12" title="goto source code">source</a></div><a href="#impl-Clone" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#12" title="goto source code">source</a></div><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h4></div></summary><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone_from" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130" title="goto source code">source</a></div><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</h4></div></summary><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Debug" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#471-475" title="goto source code">source</a></div><a href="#impl-Debug" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#472-474" title="goto source code">source</a></div><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Display" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#477-481" title="goto source code">source</a></div><a href="#impl-Display" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt-1" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#478-480" title="goto source code">source</a></div><a href="#method.fmt-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-FromStr" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#463-469" title="goto source code">source</a></div><a href="#impl-FromStr" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html" title="trait core::str::traits::FromStr">FromStr</a> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Err" class="type trait-impl has-srclink"><a href="#associatedtype.Err" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html#associatedtype.Err" class="associatedtype">Err</a> = <a class="struct" href="struct.InvalidUri.html" title="struct http::uri::InvalidUri">InvalidUri</a></h4></div></summary><div class='docblock'><p>The associated error which can be returned from parsing.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_str" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#466-468" title="goto source code">source</a></div><a href="#method.from_str" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html#tymethod.from_str" class="fnname">from_str</a>(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.InvalidUri.html" title="struct http::uri::InvalidUri">InvalidUri</a>></h4></div></summary><div class='docblock'><p>Parses a string <code>s</code> to return a value of this type. <a href="https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html#tymethod.from_str">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Hash" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#413-423" title="goto source code">source</a></div><a href="#impl-Hash" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="docblock"><p>Case-insensitive hashing</p>
<h4 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h4>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let</span> <span class="ident">a</span>: <span class="ident">Authority</span> <span class="op">=</span> <span class="string">"HELLO.com"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">b</span>: <span class="ident">Authority</span> <span class="op">=</span> <span class="string">"hello.coM"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">DefaultHasher::new</span>();
<span class="ident">a</span>.<span class="ident">hash</span>(<span class="kw-2">&mut</span> <span class="ident">s</span>);
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="ident">s</span>.<span class="ident">finish</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">DefaultHasher::new</span>();
<span class="ident">b</span>.<span class="ident">hash</span>(<span class="kw-2">&mut</span> <span class="ident">s</span>);
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">s</span>.<span class="ident">finish</span>();
<span class="macro">assert_eq!</span>(<span class="ident">a</span>, <span class="ident">b</span>);</code></pre></div>
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.hash" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#414-422" title="goto source code">source</a></div><a href="#method.hash" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash" class="fnname">hash</a><H>(&self, state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>H) <span class="where fmt-newline">where<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>, </span></h4></div></summary><div class='docblock'><p>Feeds this value into the given <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.hash_slice" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.3.0">1.3.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/hash/mod.rs.html#237-239" title="goto source code">source</a></div><a href="#method.hash_slice" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice" class="fnname">hash_slice</a><H>(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>H) <span class="where fmt-newline">where<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>, </span></h4></div></summary><div class='docblock'><p>Feeds a slice of this type into the given <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialEq%3C%26%27a%20str%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#307-311" title="goto source code">source</a></div><a href="#impl-PartialEq%3C%26%27a%20str%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.eq-4" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#308-310" title="goto source code">source</a></div><a href="#method.eq-4" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ne-4" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#219" title="goto source code">source</a></div><a href="#method.ne-4" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialEq%3CAuthority%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#271-275" title="goto source code">source</a></div><a href="#impl-PartialEq%3CAuthority%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.eq" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#272-274" title="goto source code">source</a></div><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ne" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#219" title="goto source code">source</a></div><a href="#method.ne" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialEq%3CAuthority%3E-1" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#295-299" title="goto source code">source</a></div><a href="#impl-PartialEq%3CAuthority%3E-1" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.eq-2" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#296-298" title="goto source code">source</a></div><a href="#method.eq-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ne-2" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#219" title="goto source code">source</a></div><a href="#method.ne-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialEq%3CAuthority%3E-2" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#301-305" title="goto source code">source</a></div><a href="#impl-PartialEq%3CAuthority%3E-2" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>> for &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.eq-3" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#302-304" title="goto source code">source</a></div><a href="#method.eq-3" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ne-3" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#219" title="goto source code">source</a></div><a href="#method.ne-3" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialEq%3CAuthority%3E-3" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#319-323" title="goto source code">source</a></div><a href="#impl-PartialEq%3CAuthority%3E-3" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.eq-6" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#320-322" title="goto source code">source</a></div><a href="#method.eq-6" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ne-6" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#219" title="goto source code">source</a></div><a href="#method.ne-6" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialEq%3CString%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#313-317" title="goto source code">source</a></div><a href="#impl-PartialEq%3CString%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.eq-5" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#314-316" title="goto source code">source</a></div><a href="#method.eq-5" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ne-5" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#219" title="goto source code">source</a></div><a href="#method.ne-5" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialEq%3Cstr%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#289-293" title="goto source code">source</a></div><a href="#impl-PartialEq%3Cstr%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="docblock"><p>Case-insensitive equality</p>
<h4 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h4>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">authority</span>: <span class="ident">Authority</span> <span class="op">=</span> <span class="string">"HELLO.com"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq!</span>(<span class="ident">authority</span>, <span class="string">"hello.coM"</span>);
<span class="macro">assert_eq!</span>(<span class="string">"hello.com"</span>, <span class="ident">authority</span>);</code></pre></div>
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.eq-1" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#290-292" title="goto source code">source</a></div><a href="#method.eq-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ne-1" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#219" title="goto source code">source</a></div><a href="#method.ne-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialOrd%3C%26%27a%20str%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#367-373" title="goto source code">source</a></div><a href="#impl-PartialOrd%3C%26%27a%20str%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.partial_cmp-4" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#368-372" title="goto source code">source</a></div><a href="#method.partial_cmp-4" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp" class="fnname">partial_cmp</a>(&self, other: &&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></h4></div></summary><div class='docblock'><p>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.lt-4" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1082" title="goto source code">source</a></div><a href="#method.lt-4" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt" class="fnname">lt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.le-4" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1102" title="goto source code">source</a></div><a href="#method.le-4" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le" class="fnname">le</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.gt-4" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1125" title="goto source code">source</a></div><a href="#method.gt-4" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt" class="fnname">gt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ge-4" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1145" title="goto source code">source</a></div><a href="#method.ge-4" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge" class="fnname">ge</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialOrd%3CAuthority%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#335-341" title="goto source code">source</a></div><a href="#impl-PartialOrd%3CAuthority%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a><<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="docblock"><p>Case-insensitive ordering</p>
<h4 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h4>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">authority</span>: <span class="ident">Authority</span> <span class="op">=</span> <span class="string">"DEF.com"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
<span class="macro">assert!</span>(<span class="ident">authority</span> <span class="op"><</span> <span class="string">"ghi.com"</span>);
<span class="macro">assert!</span>(<span class="ident">authority</span> <span class="op">></span> <span class="string">"abc.com"</span>);</code></pre></div>
</div><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.partial_cmp" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#336-340" title="goto source code">source</a></div><a href="#method.partial_cmp" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp" class="fnname">partial_cmp</a>(&self, other: &<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></h4></div></summary><div class='docblock'><p>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.lt" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1082" title="goto source code">source</a></div><a href="#method.lt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt" class="fnname">lt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.le" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1102" title="goto source code">source</a></div><a href="#method.le" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le" class="fnname">le</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.gt" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1125" title="goto source code">source</a></div><a href="#method.gt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt" class="fnname">gt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ge" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1145" title="goto source code">source</a></div><a href="#method.ge" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge" class="fnname">ge</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialOrd%3CAuthority%3E-1" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#351-357" title="goto source code">source</a></div><a href="#impl-PartialOrd%3CAuthority%3E-1" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a><<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.partial_cmp-2" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#352-356" title="goto source code">source</a></div><a href="#method.partial_cmp-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp" class="fnname">partial_cmp</a>(&self, other: &<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></h4></div></summary><div class='docblock'><p>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.lt-2" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1082" title="goto source code">source</a></div><a href="#method.lt-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt" class="fnname">lt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.le-2" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1102" title="goto source code">source</a></div><a href="#method.le-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le" class="fnname">le</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.gt-2" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1125" title="goto source code">source</a></div><a href="#method.gt-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt" class="fnname">gt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ge-2" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1145" title="goto source code">source</a></div><a href="#method.ge-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge" class="fnname">ge</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialOrd%3CAuthority%3E-2" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#359-365" title="goto source code">source</a></div><a href="#impl-PartialOrd%3CAuthority%3E-2" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a><<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>> for &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.partial_cmp-3" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#360-364" title="goto source code">source</a></div><a href="#method.partial_cmp-3" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp" class="fnname">partial_cmp</a>(&self, other: &<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></h4></div></summary><div class='docblock'><p>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.lt-3" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1082" title="goto source code">source</a></div><a href="#method.lt-3" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt" class="fnname">lt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.le-3" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1102" title="goto source code">source</a></div><a href="#method.le-3" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le" class="fnname">le</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.gt-3" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1125" title="goto source code">source</a></div><a href="#method.gt-3" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt" class="fnname">gt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ge-3" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1145" title="goto source code">source</a></div><a href="#method.ge-3" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge" class="fnname">ge</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialOrd%3CAuthority%3E-3" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#383-389" title="goto source code">source</a></div><a href="#impl-PartialOrd%3CAuthority%3E-3" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a><<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.partial_cmp-6" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#384-388" title="goto source code">source</a></div><a href="#method.partial_cmp-6" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp" class="fnname">partial_cmp</a>(&self, other: &<a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></h4></div></summary><div class='docblock'><p>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.lt-6" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1082" title="goto source code">source</a></div><a href="#method.lt-6" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt" class="fnname">lt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.le-6" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1102" title="goto source code">source</a></div><a href="#method.le-6" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le" class="fnname">le</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.gt-6" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1125" title="goto source code">source</a></div><a href="#method.gt-6" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt" class="fnname">gt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ge-6" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1145" title="goto source code">source</a></div><a href="#method.ge-6" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge" class="fnname">ge</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialOrd%3CString%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#375-381" title="goto source code">source</a></div><a href="#impl-PartialOrd%3CString%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.partial_cmp-5" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#376-380" title="goto source code">source</a></div><a href="#method.partial_cmp-5" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp" class="fnname">partial_cmp</a>(&self, other: &<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></h4></div></summary><div class='docblock'><p>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.lt-5" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1082" title="goto source code">source</a></div><a href="#method.lt-5" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt" class="fnname">lt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.le-5" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1102" title="goto source code">source</a></div><a href="#method.le-5" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le" class="fnname">le</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.gt-5" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1125" title="goto source code">source</a></div><a href="#method.gt-5" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt" class="fnname">gt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ge-5" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1145" title="goto source code">source</a></div><a href="#method.ge-5" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge" class="fnname">ge</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-PartialOrd%3Cstr%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#343-349" title="goto source code">source</a></div><a href="#impl-PartialOrd%3Cstr%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.partial_cmp-1" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#344-348" title="goto source code">source</a></div><a href="#method.partial_cmp-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp" class="fnname">partial_cmp</a>(&self, other: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></h4></div></summary><div class='docblock'><p>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.lt-1" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1082" title="goto source code">source</a></div><a href="#method.lt-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt" class="fnname">lt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.le-1" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1102" title="goto source code">source</a></div><a href="#method.le-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le" class="fnname">le</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.gt-1" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1125" title="goto source code">source</a></div><a href="#method.gt-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt" class="fnname">gt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ge-1" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#1145" title="goto source code">source</a></div><a href="#method.ge-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge" class="fnname">ge</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></div></summary><div class='docblock'><p>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code>
operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3C%26%27a%20%5Bu8%5D%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#425-435" title="goto source code">source</a></div><a href="#impl-TryFrom%3C%26%27a%20%5Bu8%5D%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.InvalidUri.html" title="struct http::uri::InvalidUri">InvalidUri</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#428-434" title="goto source code">source</a></div><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(s: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3C%26%27a%20str%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#437-443" title="goto source code">source</a></div><a href="#impl-TryFrom%3C%26%27a%20str%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-1" class="type trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.InvalidUri.html" title="struct http::uri::InvalidUri">InvalidUri</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from-1" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#440-442" title="goto source code">source</a></div><a href="#method.try_from-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(s: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CString%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#454-461" title="goto source code">source</a></div><a href="#impl-TryFrom%3CString%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-3" class="type trait-impl has-srclink"><a href="#associatedtype.Error-3" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.InvalidUri.html" title="struct http::uri::InvalidUri">InvalidUri</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from-3" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#458-460" title="goto source code">source</a></div><a href="#method.try_from-3" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(t: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CVec%3Cu8%2C%20Global%3E%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#445-452" title="goto source code">source</a></div><a href="#impl-TryFrom%3CVec%3Cu8%2C%20Global%3E%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>>> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-2" class="type trait-impl has-srclink"><a href="#associatedtype.Error-2" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.InvalidUri.html" title="struct http::uri::InvalidUri">InvalidUri</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from-2" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#449-451" title="goto source code">source</a></div><a href="#method.try_from-2" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(vec: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><div id="impl-Eq" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/http/uri/authority.rs.html#277" title="goto source code">source</a></div><a href="#impl-Eq" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><div id="impl-RefUnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div><div id="impl-Send" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div><div id="impl-Unpin" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div><div id="impl-UnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Authority.html" title="struct http::uri::Authority">Authority</a></h3></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Any" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132-136" title="goto source code">source</a></div><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#133" title="goto source code">source</a></div><a href="#method.type_id" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#209-214" title="goto source code">source</a></div><a href="#impl-Borrow%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211" title="goto source code">source</a></div><a href="#method.borrow" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</h4></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-222" title="goto source code">source</a></div><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219" title="goto source code">source</a></div><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</h4></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#549-553" title="goto source code">source</a></div><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#550" title="goto source code">source</a></div><a href="#method.from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Into%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#537-544" title="goto source code">source</a></div><a href="#impl-Into%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#541" title="goto source code">source</a></div><a href="#method.into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-ToOwned" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#84-96" title="goto source code">source</a></div><a href="#impl-ToOwned" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Owned" class="type trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></div></summary><div class='docblock'><p>The resulting type after obtaining ownership.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.to_owned" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89" title="goto source code">source</a></div><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></div></summary><div class='docblock'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone_into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#93" title="goto source code">source</a></div><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</h4></div></summary><div class="item-info"><div class="stab unstable"><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</div></div><div class='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-ToString" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2388-2402" title="goto source code">source</a></div><a href="#impl-ToString" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html" title="trait alloc::string::ToString">ToString</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.to_string" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2394" title="goto source code">source</a></div><a href="#method.to_string" class="anchor"></a><h4 class="code-header">pub default fn <a href="https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html#tymethod.to_string" class="fnname">to_string</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></div></summary><div class='docblock'><p>Converts the given value to a <code>String</code>. <a href="https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html#tymethod.to_string">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#589-598" title="goto source code">source</a></div><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-4" class="type trait-impl has-srclink"><a href="#associatedtype.Error-4" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from-4" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#595" title="goto source code">source</a></div><a href="#method.try_from-4" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryInto%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574-583" title="goto source code">source</a></div><a href="#impl-TryInto%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-5" class="type trait-impl has-srclink"><a href="#associatedtype.Error-5" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_into" class="method trait-impl has-srclink"><div class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#580" title="goto source code">source</a></div><a href="#method.try_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="http" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0-nightly (17d29dcdc 2022-01-21)" ></div>
</body></html> |
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `SIGEV_THREAD_ID` constant in crate `libc`."><meta name="keywords" content="rust, rustlang, rust-lang, SIGEV_THREAD_ID"><title>libc::SIGEV_THREAD_ID - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc constant"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../libc/index.html'><img src='../rust-logo.png' alt='logo' width='100'></a><div class="sidebar-elems"><p class='location'><a href='index.html'>libc</a></p><script>window.sidebarCurrent = {name: 'SIGEV_THREAD_ID', ty: 'constant', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/libc/unix/notbsd/linux/other/mod.rs.html#430' title='goto source code'>[src]</a></span><span class='in-band'>Constant <a href='index.html'>libc</a>::<wbr><a class="constant" href=''>SIGEV_THREAD_ID</a></span></h1><pre class='rust const'>pub const SIGEV_THREAD_ID: <a class="type" href="../libc/type.c_int.html" title="type libc::c_int">c_int</a></pre></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "libc";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>6. Distutils Examples — Python 3.10.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="../_static/pydoctheme.css?2021.11.1" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script src="../_static/sidebar.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python 3.10.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="next" title="7. Extending Distutils" href="extending.html" />
<link rel="prev" title="5. Creating Built Distributions" href="builtdist.html" />
<link rel="canonical" href="https://docs.python.org/3/distutils/examples.html" />
<style>
@media only screen {
table.full-width-table {
width: 100%;
}
}
</style>
<link rel="shortcut icon" type="image/png" href="../_static/py.svg" />
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script type="text/javascript" src="../_static/menu.js"></script>
<link rel="stylesheet" type="text/css" href="../../bookstyle.css"></head>
<body>
<div class="mobile-nav">
<input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
<label for="menuToggler" class="toggler__label">
<span></span>
</label>
<nav class="nav-content" role="navigation">
<a href="https://www.python.org/" class="nav-logo">
<img src="../_static/py.svg" alt="Logo"/>
</a>
<div class="version_switcher_placeholder"></div>
<form role="search" class="search" action="../search.html" method="get">
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
<path fill-rule="nonzero"
d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
</svg>
<input type="text" name="q" aria-label="Quick search"/>
<input type="submit" value="Go"/>
</form>
</nav>
<div class="menu-wrapper">
<nav class="menu" role="navigation" aria-label="main navigation">
<div class="language_switcher_placeholder"></div>
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">6. Distutils Examples</a><ul>
<li><a class="reference internal" href="#pure-python-distribution-by-module">6.1. Pure Python distribution (by module)</a></li>
<li><a class="reference internal" href="#pure-python-distribution-by-package">6.2. Pure Python distribution (by package)</a></li>
<li><a class="reference internal" href="#single-extension-module">6.3. Single extension module</a></li>
<li><a class="reference internal" href="#checking-a-package">6.4. Checking a package</a></li>
<li><a class="reference internal" href="#reading-the-metadata">6.5. Reading the metadata</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="builtdist.html"
title="previous chapter"><span class="section-number">5. </span>Creating Built Distributions</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="extending.html"
title="next chapter"><span class="section-number">7. </span>Extending Distutils</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../bugs.html">Report a Bug</a></li>
<li>
<a href="https://github.com/python/cpython/blob/3.10/Doc/distutils/examples.rst"
rel="nofollow">Show Source
</a>
</li>
</ul>
</div>
</nav>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="extending.html" title="7. Extending Distutils"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="builtdist.html" title="5. Creating Built Distributions"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://www.python.org/">Python</a> »</li>
<li class="switchers">
<div class="language_switcher_placeholder"></div>
<div class="version_switcher_placeholder"></div>
</li>
<li>
</li>
<li id="cpython-language-and-version">
<a href="../index.html">3.10.0 Documentation</a> »
</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Distributing Python Modules (Legacy version)</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">6. </span>Distutils Examples</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
|
</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="distutils-examples">
<span id="id1"></span><h1><span class="section-number">6. </span>Distutils Examples<a class="headerlink" href="#distutils-examples" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This document is being retained solely until the <code class="docutils literal notranslate"><span class="pre">setuptools</span></code> documentation
at <a class="reference external" href="https://setuptools.readthedocs.io/en/latest/setuptools.html">https://setuptools.readthedocs.io/en/latest/setuptools.html</a>
independently covers all of the relevant information currently included here.</p>
</div>
<p>This chapter provides a number of basic examples to help get started with
distutils. Additional information about using distutils can be found in the
Distutils Cookbook.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference external" href="https://wiki.python.org/moin/Distutils/Cookbook">Distutils Cookbook</a></dt><dd><p>Collection of recipes showing how to achieve more control over distutils.</p>
</dd>
</dl>
</div>
<div class="section" id="pure-python-distribution-by-module">
<span id="pure-mod"></span><h2><span class="section-number">6.1. </span>Pure Python distribution (by module)<a class="headerlink" href="#pure-python-distribution-by-module" title="Permalink to this headline">¶</a></h2>
<p>If you’re just distributing a couple of modules, especially if they don’t live
in a particular package, you can specify them individually using the
<code class="docutils literal notranslate"><span class="pre">py_modules</span></code> option in the setup script.</p>
<p>In the simplest case, you’ll have two files to worry about: a setup script and
the single module you’re distributing, <code class="file docutils literal notranslate"><span class="pre">foo.py</span></code> in this example:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">root</span><span class="o">>/</span>
<span class="n">setup</span><span class="o">.</span><span class="n">py</span>
<span class="n">foo</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>(In all diagrams in this section, <em><root></em> will refer to the distribution root
directory.) A minimal setup script to describe this situation would be:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'foo'</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="s1">'1.0'</span><span class="p">,</span>
<span class="n">py_modules</span><span class="o">=</span><span class="p">[</span><span class="s1">'foo'</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
<p>Note that the name of the distribution is specified independently with the
<code class="docutils literal notranslate"><span class="pre">name</span></code> option, and there’s no rule that says it has to be the same as
the name of the sole module in the distribution (although that’s probably a good
convention to follow). However, the distribution name is used to generate
filenames, so you should stick to letters, digits, underscores, and hyphens.</p>
<p>Since <code class="docutils literal notranslate"><span class="pre">py_modules</span></code> is a list, you can of course specify multiple
modules, eg. if you’re distributing modules <code class="xref py py-mod docutils literal notranslate"><span class="pre">foo</span></code> and <code class="xref py py-mod docutils literal notranslate"><span class="pre">bar</span></code>, your
setup might look like this:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">root</span><span class="o">>/</span>
<span class="n">setup</span><span class="o">.</span><span class="n">py</span>
<span class="n">foo</span><span class="o">.</span><span class="n">py</span>
<span class="n">bar</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>and the setup script might be</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'foobar'</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="s1">'1.0'</span><span class="p">,</span>
<span class="n">py_modules</span><span class="o">=</span><span class="p">[</span><span class="s1">'foo'</span><span class="p">,</span> <span class="s1">'bar'</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
<p>You can put module source files into another directory, but if you have enough
modules to do that, it’s probably easier to specify modules by package rather
than listing them individually.</p>
</div>
<div class="section" id="pure-python-distribution-by-package">
<span id="pure-pkg"></span><h2><span class="section-number">6.2. </span>Pure Python distribution (by package)<a class="headerlink" href="#pure-python-distribution-by-package" title="Permalink to this headline">¶</a></h2>
<p>If you have more than a couple of modules to distribute, especially if they are
in multiple packages, it’s probably easier to specify whole packages rather than
individual modules. This works even if your modules are not in a package; you
can just tell the Distutils to process modules from the root package, and that
works the same as any other package (except that you don’t have to have an
<code class="file docutils literal notranslate"><span class="pre">__init__.py</span></code> file).</p>
<p>The setup script from the last example could also be written as</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'foobar'</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="s1">'1.0'</span><span class="p">,</span>
<span class="n">packages</span><span class="o">=</span><span class="p">[</span><span class="s1">''</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
<p>(The empty string stands for the root package.)</p>
<p>If those two files are moved into a subdirectory, but remain in the root
package, e.g.:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">root</span><span class="o">>/</span>
<span class="n">setup</span><span class="o">.</span><span class="n">py</span>
<span class="n">src</span><span class="o">/</span> <span class="n">foo</span><span class="o">.</span><span class="n">py</span>
<span class="n">bar</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>then you would still specify the root package, but you have to tell the
Distutils where source files in the root package live:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'foobar'</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="s1">'1.0'</span><span class="p">,</span>
<span class="n">package_dir</span><span class="o">=</span><span class="p">{</span><span class="s1">''</span><span class="p">:</span> <span class="s1">'src'</span><span class="p">},</span>
<span class="n">packages</span><span class="o">=</span><span class="p">[</span><span class="s1">''</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
<p>More typically, though, you will want to distribute multiple modules in the same
package (or in sub-packages). For example, if the <code class="xref py py-mod docutils literal notranslate"><span class="pre">foo</span></code> and <code class="xref py py-mod docutils literal notranslate"><span class="pre">bar</span></code>
modules belong in package <code class="xref py py-mod docutils literal notranslate"><span class="pre">foobar</span></code>, one way to layout your source tree is</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">root</span><span class="o">>/</span>
<span class="n">setup</span><span class="o">.</span><span class="n">py</span>
<span class="n">foobar</span><span class="o">/</span>
<span class="fm">__init__</span><span class="o">.</span><span class="n">py</span>
<span class="n">foo</span><span class="o">.</span><span class="n">py</span>
<span class="n">bar</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>This is in fact the default layout expected by the Distutils, and the one that
requires the least work to describe in your setup script:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'foobar'</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="s1">'1.0'</span><span class="p">,</span>
<span class="n">packages</span><span class="o">=</span><span class="p">[</span><span class="s1">'foobar'</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
<p>If you want to put modules in directories not named for their package, then you
need to use the <code class="docutils literal notranslate"><span class="pre">package_dir</span></code> option again. For example, if the
<code class="file docutils literal notranslate"><span class="pre">src</span></code> directory holds modules in the <code class="xref py py-mod docutils literal notranslate"><span class="pre">foobar</span></code> package:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">root</span><span class="o">>/</span>
<span class="n">setup</span><span class="o">.</span><span class="n">py</span>
<span class="n">src</span><span class="o">/</span>
<span class="fm">__init__</span><span class="o">.</span><span class="n">py</span>
<span class="n">foo</span><span class="o">.</span><span class="n">py</span>
<span class="n">bar</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>an appropriate setup script would be</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'foobar'</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="s1">'1.0'</span><span class="p">,</span>
<span class="n">package_dir</span><span class="o">=</span><span class="p">{</span><span class="s1">'foobar'</span><span class="p">:</span> <span class="s1">'src'</span><span class="p">},</span>
<span class="n">packages</span><span class="o">=</span><span class="p">[</span><span class="s1">'foobar'</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
<p>Or, you might put modules from your main package right in the distribution
root:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">root</span><span class="o">>/</span>
<span class="n">setup</span><span class="o">.</span><span class="n">py</span>
<span class="fm">__init__</span><span class="o">.</span><span class="n">py</span>
<span class="n">foo</span><span class="o">.</span><span class="n">py</span>
<span class="n">bar</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>in which case your setup script would be</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'foobar'</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="s1">'1.0'</span><span class="p">,</span>
<span class="n">package_dir</span><span class="o">=</span><span class="p">{</span><span class="s1">'foobar'</span><span class="p">:</span> <span class="s1">''</span><span class="p">},</span>
<span class="n">packages</span><span class="o">=</span><span class="p">[</span><span class="s1">'foobar'</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
<p>(The empty string also stands for the current directory.)</p>
<p>If you have sub-packages, they must be explicitly listed in <code class="docutils literal notranslate"><span class="pre">packages</span></code>,
but any entries in <code class="docutils literal notranslate"><span class="pre">package_dir</span></code> automatically extend to sub-packages.
(In other words, the Distutils does <em>not</em> scan your source tree, trying to
figure out which directories correspond to Python packages by looking for
<code class="file docutils literal notranslate"><span class="pre">__init__.py</span></code> files.) Thus, if the default layout grows a sub-package:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">root</span><span class="o">>/</span>
<span class="n">setup</span><span class="o">.</span><span class="n">py</span>
<span class="n">foobar</span><span class="o">/</span>
<span class="fm">__init__</span><span class="o">.</span><span class="n">py</span>
<span class="n">foo</span><span class="o">.</span><span class="n">py</span>
<span class="n">bar</span><span class="o">.</span><span class="n">py</span>
<span class="n">subfoo</span><span class="o">/</span>
<span class="fm">__init__</span><span class="o">.</span><span class="n">py</span>
<span class="n">blah</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>then the corresponding setup script would be</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'foobar'</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="s1">'1.0'</span><span class="p">,</span>
<span class="n">packages</span><span class="o">=</span><span class="p">[</span><span class="s1">'foobar'</span><span class="p">,</span> <span class="s1">'foobar.subfoo'</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="single-extension-module">
<span id="single-ext"></span><h2><span class="section-number">6.3. </span>Single extension module<a class="headerlink" href="#single-extension-module" title="Permalink to this headline">¶</a></h2>
<p>Extension modules are specified using the <code class="docutils literal notranslate"><span class="pre">ext_modules</span></code> option.
<code class="docutils literal notranslate"><span class="pre">package_dir</span></code> has no effect on where extension source files are found;
it only affects the source for pure Python modules. The simplest case, a
single extension module in a single C source file, is:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">root</span><span class="o">>/</span>
<span class="n">setup</span><span class="o">.</span><span class="n">py</span>
<span class="n">foo</span><span class="o">.</span><span class="n">c</span>
</pre></div>
</div>
<p>If the <code class="xref py py-mod docutils literal notranslate"><span class="pre">foo</span></code> extension belongs in the root package, the setup script for
this could be</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="kn">from</span> <span class="nn">distutils.extension</span> <span class="kn">import</span> <span class="n">Extension</span>
<span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'foobar'</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="s1">'1.0'</span><span class="p">,</span>
<span class="n">ext_modules</span><span class="o">=</span><span class="p">[</span><span class="n">Extension</span><span class="p">(</span><span class="s1">'foo'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'foo.c'</span><span class="p">])],</span>
<span class="p">)</span>
</pre></div>
</div>
<p>If the extension actually belongs in a package, say <code class="xref py py-mod docutils literal notranslate"><span class="pre">foopkg</span></code>, then</p>
<p>With exactly the same source tree layout, this extension can be put in the
<code class="xref py py-mod docutils literal notranslate"><span class="pre">foopkg</span></code> package simply by changing the name of the extension:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="kn">from</span> <span class="nn">distutils.extension</span> <span class="kn">import</span> <span class="n">Extension</span>
<span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'foobar'</span><span class="p">,</span>
<span class="n">version</span><span class="o">=</span><span class="s1">'1.0'</span><span class="p">,</span>
<span class="n">ext_modules</span><span class="o">=</span><span class="p">[</span><span class="n">Extension</span><span class="p">(</span><span class="s1">'foopkg.foo'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'foo.c'</span><span class="p">])],</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="checking-a-package">
<h2><span class="section-number">6.4. </span>Checking a package<a class="headerlink" href="#checking-a-package" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">check</span></code> command allows you to verify if your package meta-data
meet the minimum requirements to build a distribution.</p>
<p>To run it, just call it using your <code class="file docutils literal notranslate"><span class="pre">setup.py</span></code> script. If something is
missing, <code class="docutils literal notranslate"><span class="pre">check</span></code> will display a warning.</p>
<p>Let’s take an example with a simple script:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'foobar'</span><span class="p">)</span>
</pre></div>
</div>
<p>Running the <code class="docutils literal notranslate"><span class="pre">check</span></code> command will display some warnings:</p>
<div class="highlight-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> python setup.py check
<span class="go">running check</span>
<span class="go">warning: check: missing required meta-data: version, url</span>
<span class="go">warning: check: missing meta-data: either (author and author_email) or</span>
<span class="go"> (maintainer and maintainer_email) should be supplied</span>
</pre></div>
</div>
<p>If you use the reStructuredText syntax in the <code class="docutils literal notranslate"><span class="pre">long_description</span></code> field and
<a class="reference external" href="http://docutils.sourceforge.net">docutils</a> is installed you can check if the syntax is fine with the
<code class="docutils literal notranslate"><span class="pre">check</span></code> command, using the <code class="docutils literal notranslate"><span class="pre">restructuredtext</span></code> option.</p>
<p>For example, if the <code class="file docutils literal notranslate"><span class="pre">setup.py</span></code> script is changed like this:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span>
<span class="n">desc</span> <span class="o">=</span> <span class="s2">"""</span><span class="se">\</span>
<span class="s2">My description</span>
<span class="s2">==============</span>
<span class="s2">This is the description of the ``foobar`` package.</span>
<span class="s2">"""</span>
<span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'foobar'</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="s1">'1'</span><span class="p">,</span> <span class="n">author</span><span class="o">=</span><span class="s1">'tarek'</span><span class="p">,</span>
<span class="n">author_email</span><span class="o">=</span><span class="s1">'tarek@ziade.org'</span><span class="p">,</span>
<span class="n">url</span><span class="o">=</span><span class="s1">'http://example.com'</span><span class="p">,</span> <span class="n">long_description</span><span class="o">=</span><span class="n">desc</span><span class="p">)</span>
</pre></div>
</div>
<p>Where the long description is broken, <code class="docutils literal notranslate"><span class="pre">check</span></code> will be able to detect it
by using the <code class="xref py py-mod docutils literal notranslate"><span class="pre">docutils</span></code> parser:</p>
<div class="highlight-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> python setup.py check --restructuredtext
<span class="go">running check</span>
<span class="go">warning: check: Title underline too short. (line 2)</span>
<span class="go">warning: check: Could not finish the parsing.</span>
</pre></div>
</div>
</div>
<div class="section" id="reading-the-metadata">
<h2><span class="section-number">6.5. </span>Reading the metadata<a class="headerlink" href="#reading-the-metadata" title="Permalink to this headline">¶</a></h2>
<p>The <a class="reference internal" href="apiref.html#distutils.core.setup" title="distutils.core.setup"><code class="xref py py-func docutils literal notranslate"><span class="pre">distutils.core.setup()</span></code></a> function provides a command-line interface
that allows you to query the metadata fields of a project through the
<code class="docutils literal notranslate"><span class="pre">setup.py</span></code> script of a given project:</p>
<div class="highlight-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> python setup.py --name
<span class="go">distribute</span>
</pre></div>
</div>
<p>This call reads the <code class="docutils literal notranslate"><span class="pre">name</span></code> metadata by running the
<a class="reference internal" href="apiref.html#distutils.core.setup" title="distutils.core.setup"><code class="xref py py-func docutils literal notranslate"><span class="pre">distutils.core.setup()</span></code></a> function. Although, when a source or binary
distribution is created with Distutils, the metadata fields are written
in a static file called <code class="file docutils literal notranslate"><span class="pre">PKG-INFO</span></code>. When a Distutils-based project is
installed in Python, the <code class="file docutils literal notranslate"><span class="pre">PKG-INFO</span></code> file is copied alongside the modules
and packages of the distribution under <code class="file docutils literal notranslate"><span class="pre">NAME-VERSION-pyX.X.egg-info</span></code>,
where <code class="docutils literal notranslate"><span class="pre">NAME</span></code> is the name of the project, <code class="docutils literal notranslate"><span class="pre">VERSION</span></code> its version as defined
in the Metadata, and <code class="docutils literal notranslate"><span class="pre">pyX.X</span></code> the major and minor version of Python like
<code class="docutils literal notranslate"><span class="pre">2.7</span></code> or <code class="docutils literal notranslate"><span class="pre">3.2</span></code>.</p>
<p>You can read back this static file, by using the
<code class="xref py py-class docutils literal notranslate"><span class="pre">distutils.dist.DistributionMetadata</span></code> class and its
<code class="xref py py-func docutils literal notranslate"><span class="pre">read_pkg_file()</span></code> method:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">distutils.dist</span> <span class="kn">import</span> <span class="n">DistributionMetadata</span>
<span class="gp">>>> </span><span class="n">metadata</span> <span class="o">=</span> <span class="n">DistributionMetadata</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">metadata</span><span class="o">.</span><span class="n">read_pkg_file</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="s1">'distribute-0.6.8-py2.7.egg-info'</span><span class="p">))</span>
<span class="gp">>>> </span><span class="n">metadata</span><span class="o">.</span><span class="n">name</span>
<span class="go">'distribute'</span>
<span class="gp">>>> </span><span class="n">metadata</span><span class="o">.</span><span class="n">version</span>
<span class="go">'0.6.8'</span>
<span class="gp">>>> </span><span class="n">metadata</span><span class="o">.</span><span class="n">description</span>
<span class="go">'Easily download, build, install, upgrade, and uninstall Python packages'</span>
</pre></div>
</div>
<p>Notice that the class can also be instantiated with a metadata file path to
loads its values:</p>
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">pkg_info_path</span> <span class="o">=</span> <span class="s1">'distribute-0.6.8-py2.7.egg-info'</span>
<span class="gp">>>> </span><span class="n">DistributionMetadata</span><span class="p">(</span><span class="n">pkg_info_path</span><span class="p">)</span><span class="o">.</span><span class="n">name</span>
<span class="go">'distribute'</span>
</pre></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">6. Distutils Examples</a><ul>
<li><a class="reference internal" href="#pure-python-distribution-by-module">6.1. Pure Python distribution (by module)</a></li>
<li><a class="reference internal" href="#pure-python-distribution-by-package">6.2. Pure Python distribution (by package)</a></li>
<li><a class="reference internal" href="#single-extension-module">6.3. Single extension module</a></li>
<li><a class="reference internal" href="#checking-a-package">6.4. Checking a package</a></li>
<li><a class="reference internal" href="#reading-the-metadata">6.5. Reading the metadata</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="builtdist.html"
title="previous chapter"><span class="section-number">5. </span>Creating Built Distributions</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="extending.html"
title="next chapter"><span class="section-number">7. </span>Extending Distutils</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../bugs.html">Report a Bug</a></li>
<li>
<a href="https://github.com/python/cpython/blob/3.10/Doc/distutils/examples.rst"
rel="nofollow">Show Source
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="extending.html" title="7. Extending Distutils"
>next</a> |</li>
<li class="right" >
<a href="builtdist.html" title="5. Creating Built Distributions"
>previous</a> |</li>
<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://www.python.org/">Python</a> »</li>
<li class="switchers">
<div class="language_switcher_placeholder"></div>
<div class="version_switcher_placeholder"></div>
</li>
<li>
</li>
<li id="cpython-language-and-version">
<a href="../index.html">3.10.0 Documentation</a> »
</li>
<li class="nav-item nav-item-1"><a href="index.html" >Distributing Python Modules (Legacy version)</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">6. </span>Distutils Examples</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
|
</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 2001-2021, Python Software Foundation.
<br />
This page is licensed under the Python Software Foundation License Version 2.
<br />
Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
<br />
See <a href="">History and License</a> for more information.
<br /><br />
The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
<br />
<br />
Last updated on Oct 16, 2021.
<a href="https://docs.python.org/3/bugs.html">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html> |
<div class="mar-bottom-xl" ng-if="$ctrl.showBindings">
<h3>Bindings</h3>
<service-binding
ng-repeat="binding in $ctrl.bindings track by (binding | uid)"
namespace="$ctrl.projectContext.projectName"
binding="binding"
ref-api-object="$ctrl.apiObject"
service-classes="$ctrl.serviceClasses"
service-instances="$ctrl.serviceInstances">
</service-binding>
<div ng-if="($ctrl.bindableServiceInstances | size) &&
($ctrl.serviceBindingsVersion | canI : 'create') &&
!$ctrl.apiObject.metadata.deletionTimestamp">
<a href="" ng-click="$ctrl.createBinding()" role="button">
<span class="pficon pficon-add-circle-o" aria-hidden="true"></span>
Create Binding
</a>
</div>
<div ng-if="!$ctrl.apiObject.metadata.deletionTimestamp && !($ctrl.bindableServiceInstances | size)">
<span>You must have a bindable service in your namespace in order to create bindings.</span>
<div>
<a href="./">Browse Catalog</a>
</div>
</div>
<div ng-if="!($ctrl.bindings | size) && ($ctrl.bindableServiceInstances | size) && !($ctrl.serviceBindingsVersion | canI : 'create')">
<span>There are no service bindings.</span>
</div>
</div>
<overlay-panel show-panel="$ctrl.overlayPanelVisible" handle-close="$ctrl.closeOverlayPanel">
<bind-service target="$ctrl.apiObject"
project="$ctrl.project"
on-close="$ctrl.closeOverlayPanel"></bind-service>
</overlay-panel>
|
google-site-verification: google5b6e1f34d107148b.html |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="">
<meta name="author" content="">
<title>Grayscale - Start Bootstrap Theme</title>
<!-- Bootstrap core CSS -->
<link href="vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet">
<!-- Custom fonts for this template -->
<link href="vendor/font-awesome/css/font-awesome.min.css" rel="stylesheet" type="text/css">
<link href="https://fonts.googleapis.com/css?family=Lora:400,700,400italic,700italic" rel="stylesheet" type="text/css">
<link href='https://fonts.googleapis.com/css?family=Cabin:700' rel='stylesheet' type='text/css'>
<!-- Custom styles for this template -->
<link href="css/grayscale.min.css" rel="stylesheet">
</head>
<body id="page-top">
<!-- Navigation -->
<nav class="navbar navbar-expand-lg navbar-light fixed-top" id="mainNav">
<div class="container">
<a class="navbar-brand js-scroll-trigger" href="#page-top">Start Bootstrap</a>
<button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarResponsive" aria-controls="navbarResponsive" aria-expanded="false" aria-label="Toggle navigation">
Menu
<i class="fa fa-bars"></i>
</button>
<div class="collapse navbar-collapse" id="navbarResponsive">
<ul class="navbar-nav ml-auto">
<li class="nav-item">
<a class="nav-link js-scroll-trigger" href="#about">About</a>
</li>
<li class="nav-item">
<a class="nav-link js-scroll-trigger" href="#download">Download</a>
</li>
<li class="nav-item">
<a class="nav-link js-scroll-trigger" href="#contact">Contact</a>
</li>
</ul>
</div>
</div>
</nav>
<!-- Intro Header -->
<header class="masthead">
<div class="intro-body">
<div class="container">
<div class="row">
<div class="col-lg-8 mx-auto">
<h1 class="brand-heading">Grayscale</h1>
<p class="intro-text">A free, responsive, one page Bootstrap theme.
<br>Created by Start Bootstrap.</p>
<a href="#about" class="btn btn-circle js-scroll-trigger">
<i class="fa fa-angle-double-down animated"></i>
</a>
</div>
</div>
</div>
</div>
</header>
<!-- About Section -->
<section id="about" class="content-section text-center">
<div class="container">
<div class="row">
<div class="col-lg-8 mx-auto">
<h2>About Grayscale</h2>
<p>Grayscale is a free Bootstrap theme created by Start Bootstrap. It can be yours right now, simply download the template on
<a href="http://startbootstrap.com/template-overviews/grayscale/">the preview page</a>. The theme is open source, and you can use it for any purpose, personal or commercial.</p>
<p>This theme features stock photos by
<a href="http://gratisography.com/">Gratisography</a>
along with a custom Google Maps skin courtesy of
<a href="http://snazzymaps.com/">Snazzy Maps</a>.</p>
<p>Grayscale includes full HTML, CSS, and custom JavaScript files along with SASS and LESS files for easy customization!</p>
</div>
</div>
</div>
</section>
<!-- Download Section -->
<section id="download" class="download-section content-section text-center">
<div class="container">
<div class="col-lg-8 mx-auto">
<h2>Download Grayscale</h2>
<p>You can download Grayscale for free on the preview page at Start Bootstrap.</p>
<a href="http://startbootstrap.com/template-overviews/grayscale/" class="btn btn-default btn-lg">Visit Download Page</a>
</div>
</div>
</section>
<!-- Contact Section -->
<section id="contact" class="content-section text-center">
<div class="container">
<div class="row">
<div class="col-lg-8 mx-auto">
<h2>Contact Start Bootstrap</h2>
<p>Feel free to leave us a comment on the
<a href="http://startbootstrap.com/template-overviews/grayscale/">Grayscale template overview page</a>
on Start Bootstrap to give some feedback about this theme!</p>
<ul class="list-inline banner-social-buttons">
<li class="list-inline-item">
<a href="https://twitter.com/SBootstrap" class="btn btn-default btn-lg">
<i class="fa fa-twitter fa-fw"></i>
<span class="network-name">Twitter</span>
</a>
</li>
<li class="list-inline-item">
<a href="https://github.com/BlackrockDigital/startbootstrap" class="btn btn-default btn-lg">
<i class="fa fa-github fa-fw"></i>
<span class="network-name">Github</span>
</a>
</li>
<li class="list-inline-item">
<a href="https://plus.google.com/+Startbootstrap/posts" class="btn btn-default btn-lg">
<i class="fa fa-google-plus fa-fw"></i>
<span class="network-name">Google+</span>
</a>
</li>
</ul>
</div>
</div>
</div>
</section>
<!-- Map Section -->
<div id="map"></div>
<!-- Footer -->
<footer>
<div class="container text-center">
<p>Copyright © Your Website 2017</p>
</div>
</footer>
<!-- Bootstrap core JavaScript -->
<script src="vendor/jquery/jquery.min.js"></script>
<script src="vendor/bootstrap/js/bootstrap.bundle.min.js"></script>
<!-- Plugin JavaScript -->
<script src="vendor/jquery-easing/jquery.easing.min.js"></script>
<!-- Google Maps API Key - Use your own API key to enable the map feature. More information on the Google Maps API can be found at https://developers.google.com/maps/ -->
<script src="https://maps.googleapis.com/maps/api/js?key=AIzaSyCRngKslUGJTlibkQ3FkfTxj3Xss1UlZDA&sensor=false"></script>
<!-- Custom scripts for this template -->
<script src="js/grayscale.min.js"></script>
</body>
</html>
|
<!DOCTYPE html>
<!--
Copyright (c) 2014 Intel Corporation.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of works must retain the original copyright notice, this list
of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the original copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of Intel Corporation nor the names of its contributors
may be used to endorse or promote products derived from this work without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY INTEL CORPORATION "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL INTEL CORPORATION BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Authors:
Jianfeng.Xu <jianfengx.xu@intel.com>
-->
<meta charset='utf-8'>
<title>Navigator Test: getGamepads_function</title>
<link rel="author" title="Intel" href="http://www.intel.com">
<link rel="help" href="https://dvcs.w3.org/hg/gamepadbutton/raw-file/default/gamepadbutton.html">
<meta name="assert" content="Test check if getGamepads of navigator can return array of gamepads.">
<p>Please connect and press a button on gamepad.</p>
<p>Test Passes if the show result is one or more "[object Gamepad]" </p>
<div id = "log"></div>
<script>
var log =1;
function runTest(gamepads) {
var text = "";
document.getElementById("log").innerHTML = gamepads;
}
function runAnimation() {
window.requestAnimationFrame(runAnimation);
var gamepads = navigator.getGamepads();
if(gamepads.length > 0 && log == 1) {
log =2;
runTest(gamepads);
};
}
window.requestAnimationFrame(runAnimation);
</script>
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>algebra: Not compatible</title>
<link rel="shortcut icon" type="image/png" href="../../../../../favicon.png" />
<link href="../../../../../bootstrap.min.css" rel="stylesheet">
<link href="../../../../../bootstrap-custom.css" rel="stylesheet">
<link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
<script src="../../../../../moment.min.js"></script>
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container">
<div class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<a class="navbar-brand" href="../../../../.."><i class="fa fa-lg fa-flag-checkered"></i> Coq bench</a>
</div>
<div id="navbar" class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="../..">clean / released</a></li>
<li class="active"><a href="">8.11.0 / algebra - 8.5.0</a></li>
</ul>
</div>
</div>
</div>
<div class="article">
<div class="row">
<div class="col-md-12">
<a href="../..">« Up</a>
<h1>
algebra
<small>
8.5.0
<span class="label label-info">Not compatible</span>
</small>
</h1>
<p><em><script>document.write(moment("2021-08-15 17:19:17 +0000", "YYYY-MM-DD HH:mm:ss Z").fromNow());</script> (2021-08-15 17:19:17 UTC)</em><p>
<h2>Context</h2>
<pre># Packages matching: installed
# Name # Installed # Synopsis
base-bigarray base
base-threads base
base-unix base
conf-findutils 1 Virtual package relying on findutils
coq 8.11.0 Formal proof management system
num 1.4 The legacy Num library for arbitrary-precision integer and rational arithmetic
ocaml 4.06.1 The OCaml compiler (virtual package)
ocaml-base-compiler 4.06.1 Official 4.06.1 release
ocaml-config 1 OCaml Switch Configuration
ocamlfind 1.9.1 A library manager for OCaml
# opam file:
opam-version: "2.0"
maintainer: "matej.kosik@inria.fr"
homepage: "https://github.com/coq-contribs/algebra"
license: "LGPL 2"
build: [make "-j%{jobs}%"]
install: [make "install"]
remove: ["rm" "-R" "%{lib}%/coq/user-contrib/Algebra"]
depends: [
"ocaml"
"coq" {>= "8.5" & < "8.6~"}
]
tags: [ "keyword:algebra" "category:Mathematics/Algebra" "date:1999-03" ]
authors: [ "Loïc Pottier <>" ]
bug-reports: "https://github.com/coq-contribs/algebra/issues"
dev-repo: "git+https://github.com/coq-contribs/algebra.git"
synopsis: "Basics notions of algebra"
flags: light-uninstall
url {
src: "https://github.com/coq-contribs/algebra/archive/v8.5.0.tar.gz"
checksum: "md5=9ef1b5f1f670d56a55aef37d8c511df9"
}
</pre>
<h2>Lint</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
</dl>
<h2>Dry install</h2>
<p>Dry install with the current Coq version:</p>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>opam install -y --show-action coq-algebra.8.5.0 coq.8.11.0</code></dd>
<dt>Return code</dt>
<dd>5120</dd>
<dt>Output</dt>
<dd><pre>[NOTE] Package coq is already installed (current version is 8.11.0).
The following dependencies couldn't be met:
- coq-algebra -> coq < 8.6~ -> ocaml < 4.06.0
base of this switch (use `--unlock-base' to force)
No solution found, exiting
</pre></dd>
</dl>
<p>Dry install without Coq/switch base, to test if the problem was incompatibility with the current Coq/OCaml version:</p>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>opam remove -y coq; opam install -y --show-action --unlock-base coq-algebra.8.5.0</code></dd>
<dt>Return code</dt>
<dd>0</dd>
</dl>
<h2>Install dependencies</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
<dt>Duration</dt>
<dd>0 s</dd>
</dl>
<h2>Install</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
<dt>Duration</dt>
<dd>0 s</dd>
</dl>
<h2>Installation size</h2>
<p>No files were installed.</p>
<h2>Uninstall</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
<dt>Missing removes</dt>
<dd>
none
</dd>
<dt>Wrong removes</dt>
<dd>
none
</dd>
</dl>
</div>
</div>
</div>
<hr/>
<div class="footer">
<p class="text-center">
<small>Sources are on <a href="https://github.com/coq-bench">GitHub</a>. © Guillaume Claret.</small>
</p>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script src="../../../../../bootstrap.min.js"></script>
</body>
</html>
|
---
layout: default
---
<section>
{% for post in site.posts %}
{% if post.tech != null %}
{% unless post.next %}
<h3 class="code">{{ post.date | date: '%Y' }}</h3>
{% else %}
{% capture year %}{{ post.date | date: '%Y' }}{% endcapture %}
{% capture nyear %}{{ post.next.date | date: '%Y' }}{% endcapture %}
{% if year != nyear %}
<h3 class="code">{{ post.date | date: '%Y' }}</h3>
{% endif %}
{% endunless %}
<ul>
<li>
<div class="post-date code">
<span>{{ post.date | date: "%b %d" }}</span>
</div>
<div class="title">
<a href="{{ post.url | prepend: site.baseurl | prepend: site.url }}">{{ post.title }}</a>
</div>
</li>
</ul>
{% endif %}
{% endfor %}
</section>
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!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/html; charset=UTF-8" /><title>36.52. table_privileges</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="prev" href="infoschema-table-constraints.html" title="36.51. table_constraints" /><link rel="next" href="infoschema-tables.html" title="36.53. tables" /></head><body><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">36.52. <code xmlns="http://www.w3.org/1999/xhtml" class="literal">table_privileges</code></th></tr><tr><td width="10%" align="left"><a accesskey="p" href="infoschema-table-constraints.html" title="36.51. table_constraints">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="information-schema.html" title="Chapter 36. The Information Schema">Up</a></td><th width="60%" align="center">Chapter 36. The Information Schema</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 12.5 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="infoschema-tables.html" title="36.53. tables">Next</a></td></tr></table><hr></hr></div><div class="sect1" id="INFOSCHEMA-TABLE-PRIVILEGES"><div class="titlepage"><div><div><h2 class="title" style="clear: both">36.52. <code class="literal">table_privileges</code></h2></div></div></div><p>
The view <code class="literal">table_privileges</code> identifies all
privileges granted on tables or views to a currently enabled role
or by a currently enabled role. There is one row for each
combination of table, grantor, and grantee.
</p><div class="table" id="id-1.7.6.56.3"><p class="title"><strong>Table 36.50. <code class="literal">table_privileges</code> Columns</strong></p><div class="table-contents"><table class="table" summary="table_privileges Columns" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Name</th><th>Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal">grantor</code></td><td><code class="type">sql_identifier</code></td><td>Name of the role that granted the privilege</td></tr><tr><td><code class="literal">grantee</code></td><td><code class="type">sql_identifier</code></td><td>Name of the role that the privilege was granted to</td></tr><tr><td><code class="literal">table_catalog</code></td><td><code class="type">sql_identifier</code></td><td>Name of the database that contains the table (always the current database)</td></tr><tr><td><code class="literal">table_schema</code></td><td><code class="type">sql_identifier</code></td><td>Name of the schema that contains the table</td></tr><tr><td><code class="literal">table_name</code></td><td><code class="type">sql_identifier</code></td><td>Name of the table</td></tr><tr><td><code class="literal">privilege_type</code></td><td><code class="type">character_data</code></td><td>
Type of the privilege: <code class="literal">SELECT</code>,
<code class="literal">INSERT</code>, <code class="literal">UPDATE</code>,
<code class="literal">DELETE</code>, <code class="literal">TRUNCATE</code>,
<code class="literal">REFERENCES</code>, or <code class="literal">TRIGGER</code>
</td></tr><tr><td><code class="literal">is_grantable</code></td><td><code class="type">yes_or_no</code></td><td><code class="literal">YES</code> if the privilege is grantable, <code class="literal">NO</code> if not</td></tr><tr><td><code class="literal">with_hierarchy</code></td><td><code class="type">yes_or_no</code></td><td>
In the SQL standard, <code class="literal">WITH HIERARCHY OPTION</code>
is a separate (sub-)privilege allowing certain operations on
table inheritance hierarchies. In PostgreSQL, this is included
in the <code class="literal">SELECT</code> privilege, so this column
shows <code class="literal">YES</code> if the privilege
is <code class="literal">SELECT</code>, else <code class="literal">NO</code>.
</td></tr></tbody></table></div></div><br class="table-break" /></div><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navfooter"><hr></hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="infoschema-table-constraints.html" title="36.51. table_constraints">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="information-schema.html" title="Chapter 36. The Information Schema">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="infoschema-tables.html" title="36.53. tables">Next</a></td></tr><tr><td width="40%" align="left" valign="top">36.51. <code xmlns="http://www.w3.org/1999/xhtml" class="literal">table_constraints</code> </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 12.5 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 36.53. <code xmlns="http://www.w3.org/1999/xhtml" class="literal">tables</code></td></tr></table></div></body></html> |
<div class="content-container">
<form class="card form-horizontal well" data-ng-controller="ViewProductMixController" ng-submit="submit()">
<api-validate></api-validate>
<div class="">
<h3>{{ 'label.heading.editproductmix' | translate }}</h3>
<hr>
<div class="row">
<div class="col-sm-3 col-md-3 col-md-offset-1">
<label class="control-label col-sm-9">{{ 'label.input.allowedproducts' | translate }}</label>
<select multiple ng-model="allowed" class="form-control clear"
ng-options="allowedProduct.id as allowedProduct.name for allowedProduct in allowedProducts">
</select>
</div>
<div class="paddedtop10 col-sm-1 col-md-1 paddedleft0">
<button type="button" class="btn btn-primary" data-ng-click="restrict()"><i
class="fa fa-angle-double-right"></i></button>
<br/>
<button type="button" class="btn btn-primary" data-ng-click="allow()"><i
class="fa fa-angle-double-left"></i></button>
</div>
<div class="col-sm-3 col-md-3">
<label class="control-label col-sm-9">{{ 'label.input.restrictedproducts' | translate }}</label>
<select multiple ng-model="restricted" class="form-control clear"
ng-options="restrictedProduct.id as restrictedProduct.name for restrictedProduct in restrictedProducts">
</select>
</div>
</div>
<br/>
<div class="col-md-offset-2">
<a href="#/viewproductmix/{{productmix.productId}}" class="btn btn-default">{{ 'label.button.cancel' | translate }}</a>
<button id="save" type="submit" class="btn btn-primary" has-permission='UPDATE_PRODUCTMIX'>{{ 'label.button.save' | translate }}</button>
</div>
</div>
</form>
</div>
|
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>GAConnector.register - tock</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">tock</a> / <a href="../index.html">fr.vsct.tock.bot.connector.ga</a> / <a href="index.html">GAConnector</a> / <a href="./register.html">register</a><br/>
<br/>
<h1>register</h1>
<a name="fr.vsct.tock.bot.connector.ga.GAConnector$register(fr.vsct.tock.bot.engine.ConnectorController)"></a>
<code><span class="keyword">fun </span><span class="identifier">register</span><span class="symbol">(</span><span class="identifier" id="fr.vsct.tock.bot.connector.ga.GAConnector$register(fr.vsct.tock.bot.engine.ConnectorController)/controller">controller</span><span class="symbol">:</span> <a href="../../fr.vsct.tock.bot.engine/-connector-controller/index.html"><span class="identifier">ConnectorController</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> <a href="https://github.com/voyages-sncf-technologies/tock/blob/master/bot/connector-ga/src/main/kotlin/fr/vsct/tock/bot/connector/ga/GAConnector.kt#L60">(source)</a>
<p>Overrides <a href="../../fr.vsct.tock.bot.connector/-connector/register.html">Connector.register</a></p>
<p>Registers the connector for the specified controller.</p>
</BODY>
</HTML>
|
<!DOCTYPE HTML>
<!--
Solid State by HTML5 UP
html5up.net | @ajlkn
Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)
-->
<html>
<head>
<title>Into the MineZ</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no" />
<link rel="stylesheet" href="assets/css/main.css" />
<noscript><link rel="stylesheet" href="assets/css/noscript.css" /></noscript>
</head>
<body class="is-preload">
<!-- Page Wrapper -->
<div id="page-wrapper">
<!-- Header -->
<header id="header">
<h1><a href="index.html">My Portfolio</a></h1>
</header>
<!-- Wrapper -->
<section id="wrapper">
<header>
<div class="inner">
<h2>Into the MineZ</h2>
<iframe frameborder="0" src="https://itch.io/embed/1239768?dark=true" width="552" height="167"><a href="https://maxcalhoun.itch.io/into-the-minez">Into the MineZ by MaxCalhoun</a></iframe>
</div>
</header>
<!-- Content -->
<div class="wrapper">
<div class="align-center"> <iframe width="720" height="480" src="https://www.youtube.com/embed/vkYYvFck-VM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> </div>
<div class="inner">
<section class="features">
<p>Into the MineZ is a simple dungeon-crawler style game I made in Unity. The player enters a procedurally generated dungeon and must clear out enemies lurking within.</p>
</section>
<div class="box alt">
<div class="row gtr-uniform">
<div class="col-6"><span class="image fit"><img src="images/intotheminezgameplay1.jpg" alt="" /></span></div>
<div class="col-6"><span class="image fit"><img src="images/intotheminezgameplay3.jpg" alt="" /></span></div>
<div class="col-12"><span class="image fit"><img src="images/intotheminezgameplay2.jpg" alt="" /></span></div>
</div>
</div>
</div>
</div>
</section>
<!-- Footer -->
<section id="footer">
<div class="inner">
<h2 class="major">Contact Info</h2>
</form>
<ul class="contact">
<li class="icon solid fa-phone">(440) 591-0990</li>
<li class="icon solid fa-envelope"><a href="mailto: maxpatcal@outlook">maxpatcal@outlook.com</a></li>
</ul>
<ul class="copyright">
<li>© Max Calhoun, 2021</li><li>Design: <a href="http://html5up.net">HTML5 UP</a></li>
</ul>
</div>
</section>
</div>
<!-- Scripts -->
<script src="assets/js/jquery.min.js"></script>
<script src="assets/js/jquery.scrollex.min.js"></script>
<script src="assets/js/browser.min.js"></script>
<script src="assets/js/breakpoints.min.js"></script>
<script src="assets/js/util.js"></script>
<script src="assets/js/main.js"></script>
</body>
</html> |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.7.0_141) on Fri Jun 02 06:41:09 UTC 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Interface org.apache.hadoop.yarn.webapp.hamlet.HamletSpec.TFOOT (Apache Hadoop YARN Common 2.8.1 API)</title>
<meta name="date" content="2017-06-02">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Interface org.apache.hadoop.yarn.webapp.hamlet.HamletSpec.TFOOT (Apache Hadoop YARN Common 2.8.1 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/HamletSpec.TFOOT.html" title="interface in org.apache.hadoop.yarn.webapp.hamlet">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/webapp/hamlet/class-use/HamletSpec.TFOOT.html" target="_top">Frames</a></li>
<li><a href="HamletSpec.TFOOT.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Interface org.apache.hadoop.yarn.webapp.hamlet.HamletSpec.TFOOT" class="title">Uses of Interface<br>org.apache.hadoop.yarn.webapp.hamlet.HamletSpec.TFOOT</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/HamletSpec.TFOOT.html" title="interface in org.apache.hadoop.yarn.webapp.hamlet">HamletSpec.TFOOT</a></span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.hadoop.yarn.webapp.hamlet">org.apache.hadoop.yarn.webapp.hamlet</a></td>
<td class="colLast"> </td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.apache.hadoop.yarn.webapp.hamlet">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/HamletSpec.TFOOT.html" title="interface in org.apache.hadoop.yarn.webapp.hamlet">HamletSpec.TFOOT</a> in <a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/package-summary.html">org.apache.hadoop.yarn.webapp.hamlet</a></h3>
<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/package-summary.html">org.apache.hadoop.yarn.webapp.hamlet</a> that implement <a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/HamletSpec.TFOOT.html" title="interface in org.apache.hadoop.yarn.webapp.hamlet">HamletSpec.TFOOT</a></span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class </code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/Hamlet.TFOOT.html" title="class in org.apache.hadoop.yarn.webapp.hamlet">Hamlet.TFOOT</a><T extends <a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/HamletSpec._.html" title="interface in org.apache.hadoop.yarn.webapp.hamlet">HamletSpec._</a>></strong></code> </td>
</tr>
</tbody>
</table>
<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/package-summary.html">org.apache.hadoop.yarn.webapp.hamlet</a> that return <a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/HamletSpec.TFOOT.html" title="interface in org.apache.hadoop.yarn.webapp.hamlet">HamletSpec.TFOOT</a></span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/HamletSpec.TFOOT.html" title="interface in org.apache.hadoop.yarn.webapp.hamlet">HamletSpec.TFOOT</a></code></td>
<td class="colLast"><span class="strong">HamletSpec._Table.</span><code><strong><a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/HamletSpec._Table.html#tfoot()">tfoot</a></strong>()</code>
<div class="block">Add a TFOOT element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/HamletSpec.TFOOT.html" title="interface in org.apache.hadoop.yarn.webapp.hamlet">HamletSpec.TFOOT</a></code></td>
<td class="colLast"><span class="strong">HamletSpec._Table.</span><code><strong><a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/HamletSpec._Table.html#tfoot(java.lang.String)">tfoot</a></strong>(<a href="http://download.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> selector)</code>
<div class="block">Add a TFOOT element.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/webapp/hamlet/HamletSpec.TFOOT.html" title="interface in org.apache.hadoop.yarn.webapp.hamlet">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/webapp/hamlet/class-use/HamletSpec.TFOOT.html" target="_top">Frames</a></li>
<li><a href="HamletSpec.TFOOT.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>
|
<!DOCTYPE html>
<html lang="en" class="govuk-template ">
<head>
<meta charset="utf-8">
<title>220 | Brownfield-land | Digital Land</title>
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
<meta name="theme-color" content="#0b0c0c"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<link rel="shortcut icon" sizes="48x48" href="/images/favicon.ico" type="image/x-icon">
<link rel="shortcut icon" sizes="32x32" href="/images/favicon-32x32.png" type="image/png">
<link rel="shortcut icon" sizes="16x16" href="/images/favicon-16x16.png" type="image/png">
<link rel="apple-touch-icon" href="/images/apple-touch-icon.png">
<meta name="digital-land:template" content="page-per-thing/record.html">
<script src="https://polyfill.io/v3/polyfill.min.js?features=fetch%2CPromise%2Ces6%2Ces5%2Ces2015%2Ces2016%2CURL%2CURLSearchParams%2CObject.entries%2CObject.fromEntries%2CAbortController"></script>
<!-- should make this optional, no need to load if not showing a map -->
<link rel="stylesheet" href="https://unpkg.com/leaflet@1.6.0/dist/leaflet.css"
integrity="sha512-xwE/Az9zrjBIphAcBb3F6JVqxf46+CDLwfLMHloNu6KEQCAWi6HcDUbeOfBIptF7tcCzusKFjFw2yuvEpDL9wQ=="
crossorigin="" />
<!-- Make sure you put this AFTER Leaflet's CSS -->
<script src="https://unpkg.com/leaflet@1.6.0/dist/leaflet.js"
integrity="sha512-gZwIG9x3wUXg2hdXF6+rVkLF/0Vi9U8D2Ntg4Ga5I5BZpVkVxlJWbSQtXPSiUTtC0TjtGOmxa1AJPuV0CPthew=="
crossorigin=""></script>
<!-- assets needed for fullscreen maps -->
<script src='https://api.mapbox.com/mapbox.js/plugins/leaflet-fullscreen/v1.0.1/Leaflet.fullscreen.min.js'></script>
<link href='https://api.mapbox.com/mapbox.js/plugins/leaflet-fullscreen/v1.0.1/leaflet.fullscreen.css' rel='stylesheet' />
<!-- script needed for recentring map -->
<script src="https://digital-land.github.io/javascripts/Leaflet.recentre.js"></script>
<script src="https://digital-land.github.io/javascripts/dl-maps.js"></script> <link href="https://digital-land.github.io/stylesheets/dl-frontend.css" rel="stylesheet" /> <meta property="og:image" content="/images/govuk-opengraph-image.png">
</head>
<body class="govuk-template__body ">
<script>document.body.className = ((document.body.className) ? document.body.className + ' js-enabled' : 'js-enabled');</script>
<a href="#main-content" class="govuk-skip-link">Skip to main content</a>
<!-- Cookie banner partial version 1.0.1 -->
<div id="global-cookie-message" class="govuk-clearfix global-cookie-message" data-module="cookie-banner" role="region" aria-label="cookie banner" data-nosnippet="">
<div id="cookie-banner" class="govuk-width-container">
<div class="govuk-grid-row">
<div class="govuk-grid-column-two-thirds">
<div class="cookie-banner__message govuk-!-margin-top-6">
<h2 class="govuk-heading-m">Tell us whether you accept cookies</h2>
<p class="govuk-body">We use <a class="govuk-link" href="/cookies">cookies to collect information</a> about how you use the Digital Land website to make the website work as well as possible.</p>
</div>
<div class="cooke-banner__buttons govuk-grid-row">
<div class="govuk-grid-column-one-half">
<button class="govuk-button" onclick="acceptCookies();showCookieConfirmation();">Accept all cookies</button>
</div>
<div class="govuk-grid-column-one-half">
<a class="govuk-button" href="/cookies">Set cookie preferences</a>
</div>
</div>
</div>
</div>
</div>
<div id="cookie-confirmation" class="govuk-width-container govuk-!-padding-top-6" tabindex="-1" style="display: none;">
<p class="cookie-banner__confirmation-message govuk-body">You’ve accepted all cookies. You can <a class="govuk-link" href="/cookies">change your cookie settings</a> at any time.</p>
<button class="cookie-banner__hide-button govuk-button govuk-button--secondary" onclick="document.getElementById('cookie-confirmation').style.display='none';">Hide</button>
</div>
</div><header role="banner" id="global-header" class="govuk-header with-proposition dl-header" data-module="govuk-header">
<div class="govuk-header__container govuk-width-container">
<div class="header-proposition">
<div class="govuk-header__content">
<a href="https://digital-land.github.io/" class="govuk-header__link govuk-header__link--service-name">
Digital Land
</a>
<button type="button" class="govuk-header__menu-button govuk-js-header-toggle" aria-controls="navigation" aria-label="Show or hide Top Level Navigation">Menu</button> <nav>
<ul id="navigation" class="govuk-header__navigation" aria-label="Top Level Navigation">
<li class="govuk-header__navigation-item">
<a class="govuk-header__link" href="/about">Team</a>
</li>
<li class="govuk-header__navigation-item">
<a class="govuk-header__link" href="/project/">Projects</a>
</li>
<li class="govuk-header__navigation-item">
<a class="govuk-header__link" href="/weeknote/">Weeknotes</a>
</li>
<li class="govuk-header__navigation-item">
<a class="govuk-header__link" href="/blog-post/">Blog</a>
</li>
<li class="govuk-header__navigation-item">
<a class="govuk-header__link" href="/guidance/">Guidance</a>
</li>
<li class="govuk-header__navigation-item">
<a class="govuk-header__link" href="/dataset/">Datasets</a>
</li>
<li class="govuk-header__navigation-item">
<a class="govuk-header__link" href="/organisation/">Organisations</a>
</li>
<li class="govuk-header__navigation-item">
<a class="govuk-header__link" href="/map/">Map</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="govuk-width-container ">
<div class="govuk-phase-banner">
<p class="govuk-phase-banner__content"><strong class="govuk-tag govuk-phase-banner__content__tag ">
prototype
</strong><span class="govuk-phase-banner__text">
This is a prototype. Please provide feedback to the Digital Land team.
</span>
</p>
</div><div class="govuk-breadcrumbs ">
<ol class="govuk-breadcrumbs__list">
<li class="govuk-breadcrumbs__list-item">
<a class="govuk-breadcrumbs__link" href="/">Digital Land</a>
</li>
<li class="govuk-breadcrumbs__list-item">
<a class="govuk-breadcrumbs__link" href="../../../">Brownfield Land</a>
</li>
<li class="govuk-breadcrumbs__list-item">
<a class="govuk-breadcrumbs__link" href="../../">Local Authority Eng</a>
</li>
<li class="govuk-breadcrumbs__list-item">
<a class="govuk-breadcrumbs__link" href="../">STE</a>
</li>
<li class="govuk-breadcrumbs__list-item" aria-current="page">220</li>
</ol>
</div> <main class="govuk-main-wrapper " id="main-content" role="main">
<span class="govuk-caption-xl">Brownfield land</span>
<h1 class="govuk-heading-xl">220</h1>
<div class="govuk-tabs" data-module="dlf-subnav">
<h2 class="govuk-tabs__title">
Contents
</h2>
<nav class="dlf-subnav" aria-label="Sub navigation">
<ul class="dlf-subnav__list">
<li class="dlf-subnav__list-item dlf-subnav__list-item--selected">
<a class="dlf-subnav__list-item__link" href="#record" data-module-sub-nav="tab">
Record
</a>
</li> <li class="dlf-subnav__list-item">
<a class="dlf-subnav__list-item__link" href="#history" data-module-sub-nav="tab">
History
</a>
</li><li class="dlf-subnav__list-item">
<a class="dlf-subnav__list-item__link" href="#referenced-by" data-module-sub-nav="tab">
None References
</a>
</li>
</ul>
</nav>
<div id="record">
<div class="govuk-grid-row"> <div class="govuk-grid-column-two-thirds">
<!-- this section can probably be removed. Entities no longer have a resource field --><article class="data-record govuk-!-margin-bottom-6">
<h4 class="govuk-heading-s data-record__identifier">#220</h4>
<dl class="govuk-summary-list data-record__properties"> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Site address
</dt>
<dd class="govuk-summary-list__value"> Former Parkside Residential Home. Weston Coyney Road, Stoke on Trent, and Training & Development Centre </dd>
</div> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Planning permission status
</dt>
<dd class="govuk-summary-list__value"> not permissioned </dd>
</div> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Site
</dt>
<dd class="govuk-summary-list__value"> 220 </dd>
</div> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Minimum net dwellings
</dt>
<dd class="govuk-summary-list__value"> 29 </dd>
</div> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Organisation
</dt>
<dd class="govuk-summary-list__value"><a href="/entity/?slug=/organisation/local-authority-eng/STE" class="govuk-link">Stoke-on-Trent City Council</a>
<span title="Organisation identifier: local-authority-eng:STE" class="govuk-!-font-size-16 secondary-text data-reference">(<span class="govuk-visually-hidden">Organisation identifier is </span>local-authority-eng:STE)</span>
</dd>
</div> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Name
</dt>
<dd class="govuk-summary-list__value"> 220 </dd>
</div> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Start date
</dt>
<dd class="govuk-summary-list__value"> 2017-12-31 </dd>
</div> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Hectares
</dt>
<dd class="govuk-summary-list__value"> 0.87 </dd>
</div> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Ownership status
</dt>
<dd class="govuk-summary-list__value"> owned by a public authority </dd>
</div> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Maximum net dwellings
</dt>
<dd class="govuk-summary-list__value"> 29 </dd>
</div> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Entity
</dt>
<dd class="govuk-summary-list__value"> 501460 </dd>
</div> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Entry date
</dt>
<dd class="govuk-summary-list__value"> 2020-04-01 </dd>
</div> <div class="govuk-summary-list__row">
<dt class="govuk-summary-list__key">Site plan URL
</dt>
<dd class="govuk-summary-list__value"> <a class="govuk-link" href="https://webmaplayers.stoke.gov.uk/webmaplayers8/Map.aspx?MapName=SHLAA">https://webmaplayers.stoke.gov.uk/webmaplayers8/Map.aspx?MapName=SHLAA</a> </dd>
</div>
</dl></article>
</div>
</div>
<h2 class="govuk-heading-m">Geographical area</h2>
<div class="dl-map__wrapper govuk-!-margin-top-4 dl-map__wrapper--bottom-margin" style="min-height: 460px;"><div
class="dl-map"
id="dlMap"
data-module="boundary-map"
>
<noscript>To view this map, you need to enable JavaScript.</noscript>
</div>
<a class="js-hidden dl-link-national-map" href="#">See on national map.</a>
</div>
<div class="govuk-!-margin-top-2 govuk-!-margin-bottom-6">
<a class="dl-page-action-button" href="geometry.geojson">Download geojson</a>
</div>
<h3 class="govuk-heading-m">Associated information</h3>
<ul class="govuk-list govuk-list--bullet">
<li><a href="https://digital-land.github.io/specification/schema/brownfield-land/">View the brownfield-land schema</a></li></ul>
</div><div id="history"><h2 class="govuk-heading-m dlf-subnav__heading">History</h2>
<div class="data-table__wrapper" data-module="data-table">
<div class="data-table-left-shadow with-transition"></div>
<div class="wide-table">
<table class="data-table">
<thead>
<tr>
<th>entry-date</th>
<th>resource</th>
<th>line</th>
<th>minimum-net-dwellings</th>
<th>site-address</th>
<th>name</th>
<th>point</th>
<th>site-plan-url</th>
<th>hectares</th>
<th>planning-permission-status</th>
<th>site</th>
<th>ownership-status</th>
<th>maximum-net-dwellings</th>
<th>organisation</th>
<th>start-date</th>
</tr>
</thead>
<tbody> <tr>
<td>2020-04-01</td>
<td><a href="https://github.com/digital-land/brownfield-land-collection/tree/main/transformed/brownfield-land/758c365fa791d1ac52fc7060663b350befcf32eedcb07b9c4520782c90ddcf15.csv#L10">758c365fa791...</a></td>
<td>9</td>
<td>29</td>
<td>Former Parkside Residential Home. Weston Coyney Road, Stoke on Trent, and Training & Development Centre</td>
<td>220</td>
<td>POINT(-2.107731 52.989257)</td>
<td>https://webmaplayers.stoke.gov.uk/webmaplayers8/Map.aspx?MapName=SHLAA</td>
<td>0.87</td>
<td>not permissioned</td>
<td>220</td>
<td>owned by a public authority</td>
<td>29</td>
<td>local-authority-eng:STE</td>
<td>2017-12-31</td>
</tr> <tr>
<td>2017-12-31</td>
<td><a href="https://github.com/digital-land/brownfield-land-collection/tree/main/transformed/brownfield-land/94136556187523fd3317532075e3676acfbb588aa3c4e937bd696c18c567a104.csv#L68">941365561875...</a></td>
<td>67</td>
<td>22</td>
<td>Former Parkside Residential Home, Weston Coyney Road, Stoke on Trent, and Training & Development Centre</td>
<td>220</td>
<td>POINT(-2.107731 52.989257)</td>
<td>https://webmaplayers.stoke.gov.uk/webmaplayers8/Map.aspx?MapName=SHLAA</td>
<td>0.87</td>
<td>not permissioned</td>
<td>220</td>
<td>owned by a public authority</td>
<td>22</td>
<td>local-authority-eng:STE</td>
<td>2017-12-31</td>
</tr> <tr>
<td>2017-12-31</td>
<td><a href="https://github.com/digital-land/brownfield-land-collection/tree/main/transformed/brownfield-land/51e028895eff24df83dfe680347999382385cb87edd36855a80290fc8341459c.csv#L68">51e028895eff...</a></td>
<td>67</td>
<td>22</td>
<td>Former Parkside Residential Home, Weston Coyney Road, Stoke on Trent, and Training & Development Centre</td>
<td>220</td>
<td>POINT(-2.107731 52.989257)</td>
<td></td>
<td>0.87</td>
<td>not permissioned</td>
<td>220</td>
<td>owned by a public authority</td>
<td>22</td>
<td>local-authority-eng:STE</td>
<td>2017-12-31</td>
</tr> </tbody>
</table>
</div>
<div class="data-table-right-shadow visible with-transition"></div>
</div>
</div><div id="referenced-by">
<div class="govuk-grid-row">
<div class="govuk-grid-column-two-thirds">
<h2 class="govuk-heading-m dlf-subnav__heading">Referenced by</h2>
<p class="govuk-body">This record is referenced by None other planning related data records.</p>
</div>
</div>
</div>
</main>
</div>
<div class="dlf-feedback__wrapper">
<div class="dlf-feedback">
<div class="dlf-feedback__prompt">
<div class="dlf-feedback__prompt-content">
<span class="dlf-feedback__prompt-content__text">Spotted an issue? Let us know so we can improve the data.</span>
</div>
<div class="dlf-feedback__prompt-action">
<a href="mailto:digitalLand@communities.gov.uk?subject=Feedback on (site) 220 -- brownfield-land" class="govuk-button dlf-feedback__prompt__link">There is something wrong with the data</a>
</div>
</div>
</div>
</div>
<footer class="govuk-footer " role="contentinfo"
>
<div class="govuk-width-container ">
<div class="govuk-footer__meta">
<div class="govuk-footer__meta-item govuk-footer__meta-item--grow">
<h2 class="govuk-visually-hidden">Support links</h2> <ul class="govuk-footer__inline-list">
<li class="govuk-footer__inline-list-item">
<a class="govuk-footer__link" href="/cookies">
Cookies
</a>
</li>
<li class="govuk-footer__inline-list-item">
<a class="govuk-footer__link" href="/accessibility-statement">
Accessibility statement
</a>
</li>
<li class="govuk-footer__inline-list-item">
<a class="govuk-footer__link" href="/design-system">
Design system
</a>
</li>
</ul>
<div class="govuk-footer__meta-custom">
The <a class="govuk-footer__link" href="https://github.com/digital-land/digital-land/">software</a> and <a class="govuk-footer__link" href="https://github.com/digital-land/digital-land/">data</a> used to build these pages is <a class="govuk-footer__link" href="https://github.com/digital-land/digital-land/blob/master/LICENSE">open source</a>.
</div>
<svg
role="presentation"
focusable="false"
class="govuk-footer__licence-logo"
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 483.2 195.7"
height="17"
width="41"
>
<path
fill="currentColor"
d="M421.5 142.8V.1l-50.7 32.3v161.1h112.4v-50.7zm-122.3-9.6A47.12 47.12 0 0 1 221 97.8c0-26 21.1-47.1 47.1-47.1 16.7 0 31.4 8.7 39.7 21.8l42.7-27.2A97.63 97.63 0 0 0 268.1 0c-36.5 0-68.3 20.1-85.1 49.7A98 98 0 0 0 97.8 0C43.9 0 0 43.9 0 97.8s43.9 97.8 97.8 97.8c36.5 0 68.3-20.1 85.1-49.7a97.76 97.76 0 0 0 149.6 25.4l19.4 22.2h3v-87.8h-80l24.3 27.5zM97.8 145c-26 0-47.1-21.1-47.1-47.1s21.1-47.1 47.1-47.1 47.2 21 47.2 47S123.8 145 97.8 145"
/>
</svg>
<span class="govuk-footer__licence-description">
All content is available under the
<a
class="govuk-footer__link"
href="https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/"
rel="license"
>Open Government Licence v3.0</a>, except where otherwise stated
</span>
</div>
<div class="govuk-footer__meta-item">
<a
class="govuk-footer__link govuk-footer__copyright-logo"
href="https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/"
>© Crown copyright</a>
</div>
</div>
</div>
</footer>
<script src="https://digital-land.github.io/javascripts/dl-cookies.js"></script>
<script async src='https://www.google-analytics.com/analytics.js'></script>
<!-- end google analytics -->
<script src="https://digital-land.github.io/javascripts/govuk/govuk-frontend.min.js"></script>
<script>
// initiate all GOVUK components
window.GOVUKFrontend.initAll();
</script>
<script src="https://digital-land.github.io/javascripts/dl-frontend.js"></script>
<script>
// adds any necessary polyfills
window.DLFrontend.polyfill();
</script>
<script>
const $mapElement = document.querySelector('[data-module="boundary-map"]')
const mapComponent = new DLMaps.Map($mapElement).init({
geojsonOptions: {
geojsonDataToLayer: DLMaps.brownfieldSites.geojsonToLayer
}
})
</script>
<script>
// Initialise back to top
var $data_tables = document.querySelectorAll('[data-module*="data-table"]')
$data_tables.forEach(data_table => {
new window.DLFrontend.ScrollableTables(data_table).init()
})
</script>
<script>
const $subNavTabs = document.querySelector('[data-module="dlf-subnav"]')
const subNavTabsComponent = new DLFrontend.SubNavTabs($subNavTabs).init({})
</script> </body>
</html> |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Gets an array of MongoCollection objects for all collections in this database</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />
</head>
<body class="docs"><div class="navbar navbar-fixed-top">
<div class="navbar-inner clearfix">
<ul class="nav" style="width: 100%">
<li style="float: left;"><a href="mongodb.lasterror.html">« MongoDB::lastError</a></li>
<li style="float: right;"><a href="mongodb.preverror.html">MongoDB::prevError »</a></li>
</ul>
</div>
</div>
<div id="breadcrumbs" class="clearfix">
<ul class="breadcrumbs-container">
<li><a href="index.html">PHP Manual</a></li>
<li><a href="class.mongodb.html">MongoDB</a></li>
<li>Gets an array of MongoCollection objects for all collections in this database</li>
</ul>
</div>
<div id="layout">
<div id="layout-content"><div id="mongodb.listcollections" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB::listCollections</h1>
<p class="verinfo">(PECL mongo >=0.9.0)</p><p class="refpurpose"><span class="refname">MongoDB::listCollections</span> — <span class="dc-title">Gets an array of MongoCollection objects for all collections in this database</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb.listcollections-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>MongoDB::listCollections</strong></span>
([ <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code><span class="initializer"> = array()</span></span>
] ) : <span class="type">array</span></div>
<p class="para rdfs-comment">
Gets a list of all collections in the database and returns them as an array
of <a href="class.mongocollection.html" class="classname">MongoCollection</a> objects.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">This method will use the <a href="https://docs.mongodb.com/manual/reference/command/listCollections" class="link external">» listCollections</a> database command when communicating with MongoDB 2.8+. For previous database versions, the method will query the special <em>system.namespaces</em> collection.</span></p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb.listcollections-parameters">
<h3 class="title">参数</h3>
<dl>
<dt>
<code class="parameter">options</code>
</dt>
<dd>
<p class="para">
An array of options for listing the collections. Currently available
options include:
<ul class="itemizedlist">
<li class="listitem"><p class="para"><em>"filter"</em></p><p class="para">Optional query criteria. If provided, this criteria will be used to filter the collections included in the result.</p><p class="para">Relevant fields that may be queried include <em>"name"</em> (collection name as a string, without the database name prefix) and <em>"options" (object containing options used to create the collection).</em>.</p><blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">MongoDB 2.6 and earlier versions require the <em>"name"</em> criteria, if specified, to be a string value (i.e. equality match). This is because the driver must prefix the value with the database name in order to query the <em>system.namespaces</em> collection. Later versions of MongoDB do not have this limitation, as the driver will use the listCollections command.</span></p></blockquote></li>
<li class="listitem"><p class="para"><em>"includeSystemCollections"</em></p><p class="para">Boolean, defaults to <strong><code>FALSE</code></strong>. Determines whether system collections should be included in the result.</p></li>
</ul>
</p>
<p class="para">
The following option may be used with MongoDB 2.8+:
<ul class="itemizedlist">
<li class="listitem"><p class="para"><em>"maxTimeMS"</em></p><p class="para">Specifies a cumulative time limit in milliseconds for processing the operation on the server (does not include idle time). If the operation is not completed by the server within the timeout period, a <a href="class.mongoexecutiontimeoutexception.html" class="classname">MongoExecutionTimeoutException</a> will be thrown.</p></li>
</ul>
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb.listcollections-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
Returns an array of MongoCollection objects.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongodb.listcollections-errors">
<h3 class="title">错误／异常</h3>
<p class="para">
For MongoDB 2.6 and earlier, <a href="class.mongoexception.html" class="classname">MongoException</a> will be
thrown if a non-string value was specified for the
<em>"filter"</em> option's <em>"name"</em> criteria.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-mongodb.listcollections-changelog">
<h3 class="title">更新日志</h3>
<table class="doctable informaltable">
<thead>
<tr>
<th>版本</th>
<th>说明</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>1.6.0</td>
<td>
Changed first parameter to be an array of options. Pre-1.6.0, the
first parameter was a boolean indicating the
<em>"includeSystemCollections"</em> option.
</td>
</tr>
<tr>
<td>1.3.0</td>
<td>
Added the <code class="parameter">includeSystemCollections</code> parameter.
</td>
</tr>
</tbody>
</table>
</div>
<div class="refsect1 examples" id="refsect1-mongodb.listcollections-examples">
<h3 class="title">范例</h3>
<div class="example" id="example-1533">
<p><strong>Example #1 <span class="function"><strong>MongoDB::listCollections()</strong></span> example</strong></p>
<div class="example-contents"><p>
The following example demonstrates running count on each collection in a database.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$m </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$db </span><span style="color: #007700">= </span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">selectDB</span><span style="color: #007700">(</span><span style="color: #DD0000">"demo"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$collections </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">listCollections</span><span style="color: #007700">();<br /><br />foreach (</span><span style="color: #0000BB">$collections </span><span style="color: #007700">as </span><span style="color: #0000BB">$collection</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"amount of documents in </span><span style="color: #0000BB">$collection</span><span style="color: #DD0000">: "</span><span style="color: #007700">;<br /> echo </span><span style="color: #0000BB">$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">count</span><span style="color: #007700">(), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>以上例程的输出类似于：</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
...
amount of documents in demo.pubs: 4
amount of documents in demo.elephpants: 3
amount of documents in demo.cities: 22840
...
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb.listcollections-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="mongodb.getcollectionnames.html" class="function" rel="rdfs-seeAlso">MongoDB::getCollectionNames()</a> - Gets an array of names for all collections in this database</span></li>
<li class="member"><span class="function"><a href="mongodb.getcollectioninfo.html" class="function" rel="rdfs-seeAlso">MongoDB::getCollectionInfo()</a> - Returns information about collections in this database</span></li>
</ul>
</p>
</div>
</div></div></div></body></html> |
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Img Srchttpbenhagermicrobloguploadsbadaadjpg Width</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="https://micro.blog/benhager/favicon.png" type="image/x-icon" />
<!-- Custom CSS -->
<link rel="stylesheet" href="/assets/stylesheets/global.css" />
<link rel="stylesheet" href="/custom.css" />
<link rel="alternate" type="application/rss+xml" title="Ben Hager" href="https://hager.blog/feed.xml" />
<link rel="alternate" type="application/json" title="Ben Hager" href="https://hager.blog/feed.json" />
<link rel="EditURI" type="application/rsd+xml" href="/rsd.xml" />
<link rel="me" href="https://micro.blog/benhager" />
<link rel="me" href="https://twitter.com/_benhager" />
<link rel="me" href="https://github.com/benhager" />
<link rel="me" href="https://instagram.com/stscdr" />
<link rel="authorization_endpoint" href="https://indieauth.com/auth" />
<link rel="token_endpoint" href="https://tokens.indieauth.com/token" />
<link rel="micropub" href="https://micro.blog/micropub" />
<link rel="webmention" href="https://micro.blog/webmention" />
<link rel="subscribe" href="https://micro.blog/users/follow" />
</head>
<body class="single">
<header class="header" role="banner">
<figure class="avatar">
<a href="/"><img src="https://micro.blog/benhager/avatar.jpg" alt="Ben Hager"></a>
</figure>
<h1 class="site__name">Ben Hager</h1>
<a class="site__page" href="/about/">About</a>
<a class="site__page" href="/contact/">Contact</a>
<!-- <a href="#" class="button button--primary">Subscribe</a> -->
</header>
<main class="main__content" role="main">
<article class="post--single h-entry">
<div class="e-content">
<p><img src="http://benhager.micro.blog/uploads/2017/03b4a4daad.jpg" width="600" height="600" style="height: auto" /></p>
</div>
<footer class="post__footer">
<small><time class="dt-published" datetime="2017-05-27T20:30:00-04:00">Sat, May 27, 2017 at 08:30pm</time></small>
</footer>
</article>
</main>
<footer class="footer footer--single" role="contentinfo">
<small class="copyright">© 2018 <a href="https://hager.blog">Ben Hager</a>. Follow <a href="https://micro.blog/benhager">@benhager on Micro.blog</a>.</small>
</footer>
</body>
</html>
|
{% extends "layout-signed-in.html" %}
{% block pageTitle %}
Apply to adopt a child
{% endblock %}
{% block beforeContent %}
<a class="govuk-back-link" href="javascript:history.back()">Back</a>
{% endblock %}
{% block content %}
<div class="govuk-width-container">
<div class="govuk-grid-row">
<div class="govuk-grid-column-two-thirds">
<form action="/research-feb2022-proposed-changes/check-pay-and-submit/confirmation" method="post" class="form">
<legend class="govuk-fieldset__legend govuk-fieldset__legend--l">
<span class="govuk-caption-l">{{ data['paySubmit'] }}</span>
<h1 class="govuk-fieldset__heading">
Send your application
</h1>
</legend>
<p class="govuk-body">As you are applying for help with fees, your application to adopt cannot be looked at until the court has processed your help with fees application. They will contact you if your claim is successful, or if you have some or all of the fees to pay. </p>
<div class="govuk-button-group govuk-!-margin-top-6">
<button class="govuk-button" data-module="govuk-button" name="continue" value="save-and-continue">
Confirm and send application
</button>
</form>
</div>
</div>
</div>
{% endblock %}
|
<head>
<meta charset=UTF-8>
<title> parseQueryString(string) - Mithril.js</title>
<link href="https://fonts.googleapis.com/css?family=Open+Sans" rel=stylesheet>
<link href=style.css rel=stylesheet>
<link rel=icon type=image/png sizes=32x32 href=favicon.png>
<meta name=viewport content="width=device-width,initial-scale=1">
</head>
<body>
<header>
<section>
<a class=hamburger href=javascript:;>≡</a>
<h1><img src=logo.svg> Mithril <small>2.0.2</small></h1>
<nav>
<a href=index.html>Guide</a>
<a href=api.html>API</a>
<a href=https://gitter.im/MithrilJS/mithril.js>Chat</a>
<a href=https://github.com/MithrilJS/mithril.js>GitHub</a>
</nav>
</section>
</header>
<main>
<section>
<h1 id=parsequerystringstring><a href=#parsequerystringstring>parseQueryString(string)</a></h1>
<ul>
<li>Core<ul>
<li><a href=hyperscript.html>m</a></li>
<li><a href=render.html>m.render</a></li>
<li><a href=mount.html>m.mount</a></li>
<li><a href=route.html>m.route</a></li>
<li><a href=request.html>m.request</a></li>
<li><a href=jsonp.html>m.jsonp</a></li>
<li><strong><a href=parseQueryString.html>m.parseQueryString</a></strong><ul>
<li><a href=#description>Description</a></li>
<li><a href=#signature>Signature</a></li>
<li><a href=#how-it-works>How it works</a></li>
</ul>
</li>
<li><a href=buildQueryString.html>m.buildQueryString</a></li>
<li><a href=buildPathname.html>m.buildPathname</a></li>
<li><a href=parsePathname.html>m.parsePathname</a></li>
<li><a href=trust.html>m.trust</a></li>
<li><a href=fragment.html>m.fragment</a></li>
<li><a href=redraw.html>m.redraw</a></li>
<li><a href=promise.html>Promise</a></li>
</ul>
</li>
<li>Optional<ul>
<li><a href=stream.html>Stream</a></li>
</ul>
</li>
<li>Tooling<ul>
<li><a href=https://github.com/MithrilJS/mithril.js/blob/master/ospec>Ospec</a></li>
</ul>
</li>
</ul>
<hr>
<h3 id=description><a href=#description>Description</a></h3>
<p>Turns a string of the form <code>?a=1&b=2</code> to an object</p>
<pre><code class=language-javascript>var object = m.parseQueryString("a=1&b=2")
// {a: "1", b: "2"}</code></pre>
<hr>
<h3 id=signature><a href=#signature>Signature</a></h3>
<p><code>object = m.parseQueryString(string)</code></p>
<table>
<thead>
<tr>
<th>Argument</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tr>
<td><code>string</code></td>
<td><code>String</code></td>
<td>Yes</td>
<td>A querystring</td>
</tr>
<tr>
<td><strong>returns</strong></td>
<td><code>Object</code></td>
<td></td>
<td>A key-value map</td>
</tr>
</table>
<p><a href=signatures.html>How to read signatures</a></p>
<hr>
<h3 id=how-it-works><a href=#how-it-works>How it works</a></h3>
<p>The <code>m.parseQueryString</code> method creates an object from a querystring. It is useful for handling data from URL</p>
<pre><code class=language-javascript>var data = m.parseQueryString("a=hello&b=world")
// data is {a: "hello", b: "world"}</code></pre>
<h4 id=boolean-type-casting><a href=#boolean-type-casting>Boolean type casting</a></h4>
<p>This method attempts to cast boolean values if possible. This helps prevents bugs related to loose truthiness and unintended type casts.</p>
<pre><code class=language-javascript>var data = m.parseQueryString("a=true&b=false")
// data is {a: true, b: false}</code></pre>
<h4 id=leading-question-mark-tolerance><a href=#leading-question-mark-tolerance>Leading question mark tolerance</a></h4>
<p>For convenience, the <code>m.parseQueryString</code> method ignores a leading question mark, if present:</p>
<pre><code class=language-javascript>var data = m.parseQueryString("?a=hello&b=world")
// data is {a: "hello", b: "world"}</code></pre>
<h4 id=deep-data-structures><a href=#deep-data-structures>Deep data structures</a></h4>
<p>Querystrings that contain bracket notation are correctly parsed into deep data structures</p>
<pre><code class=language-javascript>m.parseQueryString("a[0]=hello&a[1]=world")
// data is {a: ["hello", "world"]}</code></pre>
<hr>
<small>License: MIT. © Leo Horie.</small>
</section>
</main>
<script src=https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/prism.min.js defer></script>
<script src=https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/components/prism-jsx.min.js defer></script>
<script src=https://unpkg.com/mithril@2.0.2/mithril.js async></script>
<script>
document.querySelector(".hamburger").onclick = function() {
document.body.className = document.body.className === "navigating" ? "" : "navigating"
document.querySelector("h1 + ul").onclick = function() {
document.body.className = ''
}
}
</script>
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>get_null_resource</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="Chapter 1. Boost.JSON">
<link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
<link rel="prev" href="boost__json__to_string.html" title="to_string">
<link rel="next" href="boost__json__parse.html" title="parse">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__json__to_string.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__json__parse.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="json.ref.boost__json__get_null_resource"></a><a class="link" href="boost__json__get_null_resource.html" title="get_null_resource">get_null_resource</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="idm45868065847568"></a>
</p>
<p>
Return a pointer to the null resource.
</p>
<h5>
<a name="json.ref.boost__json__get_null_resource.h0"></a>
<span class="phrase"><a name="json.ref.boost__json__get_null_resource.synopsis"></a></span><a class="link" href="boost__json__get_null_resource.html#json.ref.boost__json__get_null_resource.synopsis">Synopsis</a>
</h5>
<p>
Defined in header <code class="literal"><<a href="https://github.com/cppalliance/json/blob/master/include/boost/json/null_resource.hpp" target="_top">boost/json/null_resource.hpp</a>></code>
</p>
<pre class="programlisting"><span class="identifier">memory_resource</span><span class="special">*</span>
<span class="identifier">get_null_resource</span><span class="special">();</span>
</pre>
<h5>
<a name="json.ref.boost__json__get_null_resource.h1"></a>
<span class="phrase"><a name="json.ref.boost__json__get_null_resource.description"></a></span><a class="link" href="boost__json__get_null_resource.html#json.ref.boost__json__get_null_resource.description">Description</a>
</h5>
<p>
This memory resource always throws the exception <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">bad_alloc</span></code>
in calls to <code class="computeroutput"><span class="identifier">allocate</span></code>.
</p>
<h5>
<a name="json.ref.boost__json__get_null_resource.h2"></a>
<span class="phrase"><a name="json.ref.boost__json__get_null_resource.complexity"></a></span><a class="link" href="boost__json__get_null_resource.html#json.ref.boost__json__get_null_resource.complexity">Complexity</a>
</h5>
<p>
Constant.
</p>
<h5>
<a name="json.ref.boost__json__get_null_resource.h3"></a>
<span class="phrase"><a name="json.ref.boost__json__get_null_resource.exception_safety"></a></span><a class="link" href="boost__json__get_null_resource.html#json.ref.boost__json__get_null_resource.exception_safety">Exception
Safety</a>
</h5>
<p>
No-throw guarantee.
</p>
<p>
Convenience header <code class="literal"><<a href="https://github.com/cppalliance/json/blob/master/include/boost/json.hpp" target="_top">boost/json.hpp</a>></code>
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Vinnie Falco<br>Copyright © 2020 Krystian Stasiowski<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__json__to_string.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__json__parse.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A convenient alias for a `Result` that uses `WasmError` as the error type."><meta name="keywords" content="rust, rustlang, rust-lang, WasmResult"><title>WasmResult in cranelift_wasm - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc type"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../cranelift_wasm/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../cranelift_wasm/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">WasmResult</a></h2><div class="sidebar-elems"><h2 class="location">In <a href="index.html">cranelift_wasm</a></h2><div id="sidebar-vars" data-name="WasmResult" data-ty="type" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../cranelift_wasm/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div>
<input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Type Definition <a href="index.html">cranelift_wasm</a>::<wbr><a class="type" href="#">WasmResult</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/cranelift_wasm/environ/spec.rs.html#195" title="goto source code">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust typedef"><code>pub type WasmResult<T> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="enum" href="enum.WasmError.html" title="enum cranelift_wasm::WasmError">WasmError</a>>;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A convenient alias for a <code>Result</code> that uses <code>WasmError</code> as the error type.</p>
</div></details></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="cranelift_wasm" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0-nightly (17d29dcdc 2022-01-21)" ></div>
</body></html> |
<!DOCTYPE html>
<html lang="en">
<head>
<title>LogMetrics Framework</title>
<!-- Meta -->
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="LogMetrics Framework">
<meta name="description"
content="LogMetrics Framework provides simplified configuration to log payload for spring java projects & python projects">
<meta name="keywords"
content="LogMetrics,LogMetrics,LogMetrics.org,LogMetrics, LogMetrics for Spring Projects, LogMetrics for Python Projects">
<meta name="robots" content="index, follow">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="language" content="English">
<meta name="revisit-after" content="30 days">
<meta name="author" content="Devxchange.io">
<link rel="shortcut icon" href="favicon.ico">
<link href='https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
<!-- FontAwesome JS -->
<script defer src="https://use.fontawesome.com/releases/v5.8.2/js/all.js" integrity="sha384-DJ25uNYET2XCl5ZF++U8eNxPWqcKohUUBUpKGlNLMchM7q4Wjg2CUpjHLaL8yYPH" crossorigin="anonymous"></script>
<!-- Global CSS -->
<link rel="stylesheet" href="assets/plugins/bootstrap/css/bootstrap.min.css">
<!-- Plugins CSS -->
<link rel="stylesheet" href="assets/plugins/prism/prism.css">
<link rel="stylesheet" href="assets/plugins/elegant_font/css/style.css">
<!-- Theme CSS -->
<link id="theme-style" rel="stylesheet" href="assets/css/styles.css">
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-154410551-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-154410551-1');
</script>
</head>
<body class="body-green">
<div class="page-wrapper">
<!-- ******Header****** -->
<header id="header" class="header">
<div class="container">
<div class="branding">
<h1 class="logo">
<a href="index.html">
<span aria-hidden="true" class="icon_documents_alt icon"></span>
<span class="text-highlight">LogMetrics</span>
</a>
</h1>
</div><!--//branding-->
<ol class="breadcrumb">
<li class="breadcrumb-item"><a href="index.html">Home</a></li>
<li class="breadcrumb-item active">LogMetrics Framework</li>
</ol>
</div><!--//container-->
</header><!--//header-->
<div class="doc-wrapper">
<div class="container">
<div id="doc-header" class="doc-header text-center">
<h1 class="doc-title"><i class="icon_datareport_alt"></i> LogMetrics Framework</h1>
<div class="meta"><i class="far fa-clock"></i> Last updated: Nov 23th, 2019</div>
</div><!--//doc-header-->
<div class="doc-body row">
<div class="doc-content col-md-9 col-12 order-1">
<div class="content-inner">
<section id="download-section" class="doc-section">
<h2 class="section-title">General</h2>
<div class="section-block">
<p>LogMetrics Framework is used to collect and log the API metrics data and capture
the request and response payload.
</p>
</div>
</section><!--//doc-section-->
<section id="code-section" class="doc-section">
<h2 class="section-title">Java</h2>
<div class="section-block">
<p>LogMetrics provides simplified configuration to log payload for
spring java projects</p>
</div><!--//section-block-->
<div id="repo" class="section-block">
<div class="code-block">
<h6>Repository</h6>
<pre><code class="language-javascript"> maven { url "https://dl.bintray.com/m2/release"}</code></pre>
</div><!--//code-block-->
</div><!--//section-block-->
<div id="dependency" class="section-block">
<div class="code-block">
<h6>Dependency- Gradle</h6>
<pre><code class="language-javascript">compile ("io.devxchange:logmetrics:0.0.2")</code></pre>
</div><!--//code-block-->
</div><!--//section-block-->
<div id="properties" class="section-block">
<div class="code-block">
<h6>properties</h6>
<pre><code class="language-css">logmetrics.logging.enabled=true
logmetrics.logging.request.enabled=true
logmetrics.logging.response.enabled=true
logmetrics.logging.obfuscate.enabled=false
logmetrics.logging.obfuscate.md5.fields= #comma seperated fields
logmetrics.logging.obfuscate.sha256.fields= #comma seperated fields
logmetrics.logging.obfuscate.fields= #comma seperated fields</code></pre>
</div><!--//code-block-->
</div><!--//section-block-->
<div id="appconfig" class="section-block">
<div class="code-block">
<h6>AppConfig</h6>
<pre><code class="language-javascript">@Configuration
@EnableWebMvc
public class AppConfig extends WebMvcConfigurerAdapter
{
@Autowired
@Qualifier("manager.logwriter")
private LogWriterManager logWriterManager;
@Override
public void addInterceptors(InterceptorRegistry registry)
{
registry.addInterceptor(new RestTransactionInterceptor(logWriterManager));
}
} </code></pre>
<h6>SpringApplication</h6>
<pre><code class="language-javascript">import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;
@SpringBootApplication
@ComponentScan(basePackages = {"io.devxchange.logmetrics"})
public class LoggingDemoApplication {
public static void main(String[] args) {
SpringApplication.run(LoggingDemoApplication.class, args);
}
}
</code></pre>
</div><!--//code-block-->
</div><!--//section-block-->
<div id="schema" class="section-block">
<div class="code-block">
<h6>Logmetrics Schema</h6>
<pre><code class="language-javascript">
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "LogMetrics",
"properties": {
"Node": {
"type": "string",
"description": "Application Host IP Address"
},
"message_type": {
"type": "string",
"description": "Logmetrics message type",
"value": "LOGMETRICS_MESSAGE"
},
"Duration": {
"type": "integer",
"description": "Response time of the API"
},
"Host": {
"type": "string",
"description": "Application Host Name"
},
"Fault": {
"type": "boolean",
"description": "API Success or Failed status "
},
"Method": {
"type": "string",
"description": "API Method name"
},
"ResponseBody": {
"type": "string",
"description": "API Response Body"
},
"StartDateTime": {
"type": "string",
"description": "API Start Time"
},
"EndDateTime": {
"type": "string",
"description": "API End time"
},
"HttpMethod": {
"type": "string",
"description": "Http Method Type"
},
"RequestBody": {
"type": "string",
"description": "API Request Body"
}
}
}</code></pre></div><!--//code-block-->
</div><!--//section-block-->
<div id="release" class="section-block">
<div class="code-block">
<h6>Release</h6>
<h7>0.0.2</h7>
<pre><code class="language-handlebars">adding request and response payload obfuscation (masking sensitive information)
</code></pre>
<h7>0.0.1</h7>
<pre><code class="language-handlebars">logging rest verb & payload to console.
feature to enable/disable payload logging
</code></pre>
</div><!--//code-block-->
</div><!--//section-block-->
<div id="demo" class="section-block">
<div class="code-block">
<h6>Git Demo Example</h6>
<pre><code class="language-git">$ git clone https://github.com/devxchange-blog/logmetrics-demo.git </code></pre>
</br>
<img src="assets/gifs/logmetrics-demo.gif">
</div><!--//code-block-->
</div><!--//section-block-->
</section><!--//doc-section-->
<section id="python-code-section" class="doc-section">
<h2 class="section-title">Python</h2>
<div class="section-block">
<p>LogMetrics provides simplified configuration to log payload for
python flask projects</p>
</div><!--//section-block-->
<div id="python-install" class="section-block">
<div class="code-block">
<h6>Pypi Module</h6>
<pre><code class="language-javascript">pip install logmetrics-sdk</code></pre>
</div><!--//code-block-->
</div><!--//section-block-->
<div id="python-properties" class="section-block">
<div class="code-block">
<h6>properties</h6>
<pre><code class="language-css">enable_logmetrics= True
enable_frontend_request= True
enable_frontend_response= True
enable_backend= True
enable_backend_request= True
enable_backend_response= True </code></pre>
</div><!--//code-block-->
</div><!--//section-block-->
<div id="python-usage" class="section-block">
<div class="code-block">
<h6>Usage</h6>
<pre><code class="language-javascript">from logmetrics_sdk.logmetrics import LogMetrics
@app.route('/todo/api/v1/tasks', methods=['GET'])
@LogMetrics(enable_logmetrics=True,
enable_frontend_request=True,
enable_frontend_response=True,
enable_backend=True,
enable_backend_request=True,
enable_backend_response=True)
def get_tasks():
return jsonify(tasks)</code></pre>
</div><!--//code-block-->
</div><!--//section-block-->
<div id="python-schema" class="section-block">
<div class="code-block">
<h6>Logmetrics Schema</h6>
<pre><code class="language-javascript">{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "LogMetrics",
"properties": {
"Node": {
"type": "string",
"description": "Application Host IP Address"
},
"MessageType": {
"type": "string",
"description": "Logmetrics message type",
"value": "LOGMETRICS_MESSAGE"
},
"Duration": {
"type": "integer",
"description": "Response time of the API"
},
"Host": {
"type": "string",
"description": "Application Host Name"
},
"Fault": {
"type": "boolean",
"description": "API Success or Failed status "
},
"Method": {
"type": "string",
"description": "API Method name"
},
"ResponseBody": {
"type": "string",
"description": "API Response Body"
},
"StartDateTime": {
"type": "string",
"description": "API Start Time"
},
"EndDateTime": {
"type": "string",
"description": "API End time"
},
"HttpMethod": {
"type": "string",
"description": "Http Method Type"
},
"RequestBody": {
"type": "string",
"description": "API Request Body"
}
}
}</code></pre></div><!--//code-block-->
</div><!--//section-block-->
<div id="python-release" class="section-block">
<div class="code-block">
<h6>Release</h6>
<h7>1.0.3</h7>
<pre><code class="language-handlebars">logging rest verb & payload to console.
feature to enable/disable payload logging
</code></pre></div><!--//code-block-->
</div><!--//section-block-->
<div id="python-demo" class="section-block">
<div class="code-block">
<h6>Git Demo Example</h6>
<pre><code class="language-git">$ git clone https://github.com/devxchange-blog/logmetrics-python-demo.git </code></pre>
</br>
</div><!--//code-block-->
</div><!--//section-block-->
</section><!--//doc-section-->
<section id="go-section" class="doc-section">
<h2 class="section-title">Go</h2>
<div class="section-block">
<p><strong>Development In Progress</strong> - LogMetrics provides simplified
configuration to log payload for Go projects</p>
</div><!--//section-block-->
</section><!--//doc-section-->
</div><!--//content-inner-->
</div><!--//doc-content-->
<div class="doc-sidebar col-md-3 col-12 order-0 d-none d-md-flex">
<div id="doc-nav" class="doc-nav">
<nav id="doc-menu" class="nav doc-menu flex-column sticky">
<a class="nav-link scrollto" href="#download-section">General</a>
<a class="nav-link scrollto" href="#code-section">Java</a>
<nav class="doc-sub-menu nav flex-column">
<a class="nav-link scrollto" href="#repo">Repository</a>
<a class="nav-link scrollto" href="#dependency">Dependency</a>
<a class="nav-link scrollto" href="#properties">Properties</a>
<a class="nav-link scrollto" href="#appconfig">AppConfig</a>
<a class="nav-link scrollto" href="#schema">Schema</a>
<a class="nav-link scrollto" href="#release">Release</a>
<a class="nav-link scrollto" href="#demo">Demo</a>
</nav><!--//nav-->
<a class="nav-link scrollto" href="#python-code-section">Python</a>
<nav class="doc-sub-menu nav flex-column">
<a class="nav-link scrollto" href="#python-install">PyPi Module</a>
<a class="nav-link scrollto" href="#python-properties">Properties</a>
<a class="nav-link scrollto" href="#python-usage">Usage</a>
<a class="nav-link scrollto" href="#python-schema">Schema</a>
<a class="nav-link scrollto" href="#python-release">Release</a>
<a class="nav-link scrollto" href="#python-demo">Demo</a>
</nav><!--//nav-->
<a class="nav-link scrollto" href="#go-section">Go</a>
</nav><!--//doc-menu-->
</div>
</div><!--//doc-sidebar-->
</div><!--//doc-body-->
</div><!--//container-->
</div><!--//doc-wrapper-->
</div><!--//page-wrapper-->
<footer class="footer text-center">
<div class="container">
<small class="copyright">Copyright © 2019 DevXchange.io</small><br>
<small class="copyright">Theme by <a href ="https://themes.3rdwavemedia.com/" target="_blank">3rd
Wave Media</a></small>
</div><!--//container-->
</footer><!--//footer-->
<!-- Main Javascript -->
<script type="text/javascript" src="assets/plugins/jquery-3.3.1.min.js"></script>
<script type="text/javascript" src="assets/plugins/bootstrap/js/bootstrap.min.js"></script>
<script type="text/javascript" src="assets/plugins/prism/prism.js"></script>
<script type="text/javascript" src="assets/plugins/jquery-scrollTo/jquery.scrollTo.min.js"></script>
<script type="text/javascript" src="assets/plugins/stickyfill/dist/stickyfill.min.js"></script>
<script type="text/javascript" src="assets/js/main.js"></script>
</body>
</html>
|
<div ng-app="myApp.view3">
<div id="simple" ng-controller="MyController">
<div class="col-xs-6">
</div>
<!-- novalidate prevents native form validation-->
<form novalidate class="form-horizontal col-xs-6">
<!-- The below inputs will add attributes to the input object-->
<div class="form-group">
<label for="name" class="control-label col-md-2">Name</label>
<div class="col-md-10">
<input type="text" ng-model="input.name" id="name" class="form-control" autofocus required>
</div>
</div>
<div class="form-group">
<label for="email" class="control-label col-md-2">Email</label>
<div class="col-md-10">
<input type="email" ng-model="input.email" id="email" class="form-control" required>
</div>
</div>
<div class="form-group">
<label for="usrName" class="control-label col-md-2">Username</label>
<div class="col-md-10">
<input type="text" ng-model="input.usrName" id="usrName" class="form-control" required>
</div>
</div>
<div class="form-group">
<label for="pswrd1" class="control-label col-md-2">Enter Password</label>
<div class="col-md-10">
<input type="password" ng-model="input.pswrd1" id="pswrd1" class="form-control" required>
</div>
</div>
<div class="form-group">
<label for="pswrd2" class="control-label col-md-2">Confirm Password</label>
<div class="col-md-10">
<input type="password" ng-model="input.pswrd2" id="pswrd2" class="form-control" required>
</div>
</div>
<div class="form-group">
<label for="address" class="control-label col-md-2">Address</label>
<div class="col-md-10">
<input type="text" ng-model="input.address" id="address" class="form-control">
</div>
</div>
<div class="form-group">
<label for="telNo" class="control-label col-md-2">Telephone</label>
<div class="col-md-10">
<input type="tel" ng-model="input.telNo" id="telNo" class="form-control">
</div>
</div>
<br>
<br>
<input type="radio" ng-model="input.gender" value="male" class="view3Radio" id="leftBtn">male
<input type="radio" ng-model="input.gender" value="female" class="view3Radio">female<br>
<!-- This button will call the reset function to clear out the text boxes-->
<input type="button" ng-click="reset()" value="Reset" class="btn btn-primary view3btn">
<!--This button will call the update function to parse the object to JSON and print the
value below-->
<input type="submit" ng-click="update(input)" value="Save" class="btn btn-success view3btn">
</form>
<!-- Piping to JSON, this element has a display:none rule in the css file-->
<pre id="formCapture">form = {{user | json}}</pre>
<!-- Printing the JSON data-->
<pre ng-repeat="object in list">{{object}}</pre>
</div>
</div>
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="apple-touch-icon" sizes="180x180" href="/storybooks-fsl/apple-touch-icon.png?v=4">
<link rel="icon" type="image/png" sizes="32x32" href="/storybooks-fsl/favicon-32x32.png?v=4">
<link rel="icon" type="image/png" sizes="16x16" href="/storybooks-fsl/favicon-16x16.png?v=4">
<link rel="manifest" href="/storybooks-fsl/site.webmanifest?v=4">
<link rel="mask-icon" href="/storybooks-fsl/safari-pinned-tab.svg?v=4" color="#5bbad5">
<link rel="shortcut icon" href="/storybooks-fsl/favicon.ico?v=4">
<meta name="msapplication-TileColor" content="#00aba9">
<meta name="theme-color" content="#ffffff">
<title>Zama rất ngoan! - Contes pour le français langue seconde</title>
<meta name="description" content="Contes pour le français langue seconde est une ressource éducative ouverte et gratuite qui encourage l’alphabétisation et l’apprentissage des langues dans les foyers, les écoles, et les collectivités qui présents 40 contes du Livre de contes africains disponibles en texte et en version audio en français et plusieurs autres langues du monde.
">
<link rel="stylesheet" href="/storybooks-fsl/css/spectre.min.css">
<link rel="stylesheet" href="/storybooks-fsl/css/gsn.min.css">
<link rel="stylesheet" href="/storybooks-fsl/css/fontello.min.css">
<link rel="canonical" href="https://global-asp.github.io//storybooks-fsl/stories/vi/0095/">
<link rel="alternate" type="application/rss+xml" title="Contes pour le français langue seconde" href="/storybooks-fsl">
<script src="/storybooks-fsl/js/sbc.min.js"></script>
</head>
<body>
<div class="container">
<header class="navbar">
<section class="navbar-section">
<a href="/storybooks-fsl/" class="navbar-brand">
<object type="image/svg+xml" data="/storybooks-fsl/images/sbfsl_logo.svg" width="100" height="100" border="0"></object>
</a>
<div class="btn-group btn-group-block">
<a href="/storybooks-fsl/" class="btn btn-primary">Accueil</a>
<div class="dropdown">
<a href="#" class="btn btn-primary dropdown-toggle" tabindex="0">A propos</a>
<ul class="menu">
<li class="menu-item"><a href="/storybooks-fsl/about">Qui sommes nous?</a></li>
<li class="menu-item"><a href="/storybooks-fsl/about/languages">Langues</a></li>
</ul>
</div>
<a href="/storybooks-fsl/how-to" class="btn btn-primary">Comment utiliser ce site</a>
<a href="/storybooks-fsl/contact" class="btn btn-primary">Nous contacter</a>
</div>
</section>
</header>
<div class="float-right"><span class="tooltip tooltip-left" data-tooltip="Le téléchargement PDF de ce conte est actuellement indisponible"><a class="btn btn-lg disabled">Téléchargement PDF</a></span></div>
<div class="float-right">
<select class="btn btn-lg" onchange="window.location=this.value" accesskey="l">
<option selected="" disabled="">Changer de langue</option>
<option value="/storybooks-fsl/stories/fr/0095">français</option>
<option value="/storybooks-fsl/stories/de/0095">allemand</option>
<option value="/storybooks-fsl/stories/am/0095">amharique</option>
<option value="/storybooks-fsl/stories/en/0095">anglais</option>
<option value="/storybooks-fsl/stories/ar/0095">arabe</option>
<option value="/storybooks-fsl/stories/bn/0095">bengali</option>
<option value="/storybooks-fsl/stories/yue/0095">cantonais</option>
<option value="/storybooks-fsl/stories/zh/0095">chinois (mandarin)</option>
<option value="/storybooks-fsl/stories/ko/0095">coréen</option>
<option value="/storybooks-fsl/stories/prs/0095">dari</option>
<option value="/storybooks-fsl/stories/es/0095">espagnol</option>
<option value="/storybooks-fsl/stories/it/0095">italien</option>
<option value="/storybooks-fsl/stories/sw/0095">kiswahili</option>
<option value="/storybooks-fsl/stories/nb/0095">norvégien (bokmål)</option>
<option value="/storybooks-fsl/stories/nn/0095">norvégien (nynorsk)</option>
<option value="/storybooks-fsl/stories/ur/0095">ourdou</option>
<option value="/storybooks-fsl/stories/pa/0095">pendjabi</option>
<option value="/storybooks-fsl/stories/fa/0095">persan</option>
<option value="/storybooks-fsl/stories/pl/0095">polonais</option>
<option value="/storybooks-fsl/stories/so/0095">somali</option>
<option value="/storybooks-fsl/stories/tl/0095">tagalog</option>
<option value="/storybooks-fsl/stories/bo/0095">tibétain</option>
<option value="/storybooks-fsl/stories/tr/0095">turc</option>
</select>
</div>
<a class="btn btn-lg" href="/storybooks-fsl/stories/vi">Retour à la liste des contes</a><br><br>
<div class="columns" id="text01">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/01.jpg"></div>
<div class=" column col-7 col-lg-12 col-md-12 col-sm-12">
<h1><span class="def">Zama rất ngoan!</span>
<span class="l1">Zama est formidable !</span>
</h1>
<div class="btn-group cover-buttons">
<a href="#text02" class="btn btn-lg" title="Page suivante"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton01" onclick="playpause('01')" title="lecture/pause"><i class="icon-volume-up"></i></button>
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
<h3><span class="tooltip tooltip-right" data-tooltip="Écrit par"><img class="cover-icon cover-icon-text" src="/storybooks-fsl/css/pencil.svg" alt="Écrit par"></span> Michael Oguttu</h3>
<h3><span class="tooltip tooltip-right" data-tooltip="Illustré par"><img class="cover-icon cover-icon-text" src="/storybooks-fsl/css/art.svg" alt="Illustré par"></span> Vusi Malindi</h3>
<h3><span class="tooltip tooltip-right" data-tooltip="Traduit par"><img class="cover-icon cover-icon-text" src="/storybooks-fsl/css/global.svg" alt="Traduit par"></span> Phuong Nguyen</h3>
<h3><span class="tooltip tooltip-right" data-tooltip="Langue"><img class="cover-icon cover-icon-text" src="/storybooks-fsl/css/language.svg" alt="Langue"></span> <a href="/storybooks-fsl/stories/vi">vietnamien</a></h3>
<h3><span class="tooltip tooltip-right" data-tooltip="Niveau"><img class="cover-icon cover-icon-text" src="/storybooks-fsl/css/level.svg" alt="Niveau"></span> <a href="/storybooks-fsl/stories/vi/level2">Niveau 2</a></h3>
<h3><span class="tooltip tooltip-right" data-tooltip="Lire l’histoire"><img class="cover-icon cover-icon-text" src="/storybooks-fsl/css/speaker.svg" alt="Lire l’histoire en entier"></span> <span class="cover_msg">L’enregistrement audio de cette histoire est actuellement indisponible.</span></h3>
</div>
</div>
<hr>
<div id="text02" class="columns">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/02.jpg"></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt def"><h3>
Em trai tôi ngủ dậy rất trễ. Tôi ngủ dậy sớm, bởi vì tôi ngoan!
</h3></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt l1"><h3>
Mon petit frère dort très tard. Je me réveille tôt, parce que je suis formidable !
</h3></div>
<div class="column col-1 col-lg-1 col-md-12 col-sm-12">
<div class="btn-group switcher-group">
<a href="#text01" class="btn btn-lg" title="Page précédente"><i class="icon-arrow-up"></i></a>
<a href="#text03" class="btn btn-lg" title="Page suivante"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton02" onclick="playpause('02')" title="lecture/pause"><i class="icon-volume-up"></i></button>
</div>
<div class="btn-group switcher-group">
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
</div>
</div>
<hr>
<div id="text03" class="columns">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/03.jpg"></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt def"><h3>
Tôi là người mở cửa đón ánh mặt trời.
</h3></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt l1"><h3>
Je suis celle qui laisse entrer le soleil.
</h3></div>
<div class="column col-1 col-lg-1 col-md-12 col-sm-12">
<div class="btn-group switcher-group">
<a href="#text02" class="btn btn-lg" title="Page précédente"><i class="icon-arrow-up"></i></a>
<a href="#text04" class="btn btn-lg" title="Page suivante"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton03" onclick="playpause('03')" title="lecture/pause"><i class="icon-volume-up"></i></button>
</div>
<div class="btn-group switcher-group">
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
</div>
</div>
<hr>
<div id="text04" class="columns">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/04.jpg"></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt def"><h3>
Mẹ nói, “Con là ngôi sao buổi sáng của mẹ.”
</h3></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt l1"><h3>
« Tu es mon étoile du matin, » me dit maman.
</h3></div>
<div class="column col-1 col-lg-1 col-md-12 col-sm-12">
<div class="btn-group switcher-group">
<a href="#text03" class="btn btn-lg" title="Page précédente"><i class="icon-arrow-up"></i></a>
<a href="#text05" class="btn btn-lg" title="Page suivante"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton04" onclick="playpause('04')" title="lecture/pause"><i class="icon-volume-up"></i></button>
</div>
<div class="btn-group switcher-group">
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
</div>
</div>
<hr>
<div id="text05" class="columns">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/05.jpg"></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt def"><h3>
Tôi tự tắm mà không cần ai giúp.
</h3></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt l1"><h3>
Je me lave, je n’ai pas besoin d’aide.
</h3></div>
<div class="column col-1 col-lg-1 col-md-12 col-sm-12">
<div class="btn-group switcher-group">
<a href="#text04" class="btn btn-lg" title="Page précédente"><i class="icon-arrow-up"></i></a>
<a href="#text06" class="btn btn-lg" title="Page suivante"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton05" onclick="playpause('05')" title="lecture/pause"><i class="icon-volume-up"></i></button>
</div>
<div class="btn-group switcher-group">
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
</div>
</div>
<hr>
<div id="text06" class="columns">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/06.jpg"></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt def"><h3>
Tôi có thể chịu được nước lạnh và xà bông màu xanh có mùi.
</h3></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt l1"><h3>
Je peux m’adapter à de l’eau froide et du savon bleu malodorant.
</h3></div>
<div class="column col-1 col-lg-1 col-md-12 col-sm-12">
<div class="btn-group switcher-group">
<a href="#text05" class="btn btn-lg" title="Page précédente"><i class="icon-arrow-up"></i></a>
<a href="#text07" class="btn btn-lg" title="Page suivante"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton06" onclick="playpause('06')" title="lecture/pause"><i class="icon-volume-up"></i></button>
</div>
<div class="btn-group switcher-group">
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
</div>
</div>
<hr>
<div id="text07" class="columns">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/07.jpg"></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt def"><h3>
Mẹ nhắc, “Đừng quên đánh răng nhé.” Tôi nói, “Con thì không bao giờ.”
</h3></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt l1"><h3>
Maman me rappelle, « N’oublie pas tes dents. » Je réponds, « Jamais, pas moi ! »
</h3></div>
<div class="column col-1 col-lg-1 col-md-12 col-sm-12">
<div class="btn-group switcher-group">
<a href="#text06" class="btn btn-lg" title="Page précédente"><i class="icon-arrow-up"></i></a>
<a href="#text08" class="btn btn-lg" title="Page suivante"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton07" onclick="playpause('07')" title="lecture/pause"><i class="icon-volume-up"></i></button>
</div>
<div class="btn-group switcher-group">
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
</div>
</div>
<hr>
<div id="text08" class="columns">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/08.jpg"></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt def"><h3>
Sau khi rửa ráy, tôi chào ông và dì, và chúc họ có một ngày tốt lành.
</h3></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt l1"><h3>
Après m’être lavée, j’accueille grand-papa et tantine et je leur souhaite une bonne journée.
</h3></div>
<div class="column col-1 col-lg-1 col-md-12 col-sm-12">
<div class="btn-group switcher-group">
<a href="#text07" class="btn btn-lg" title="Page précédente"><i class="icon-arrow-up"></i></a>
<a href="#text09" class="btn btn-lg" title="Page suivante"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton08" onclick="playpause('08')" title="lecture/pause"><i class="icon-volume-up"></i></button>
</div>
<div class="btn-group switcher-group">
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
</div>
</div>
<hr>
<div id="text09" class="columns">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/09.jpg"></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt def"><h3>
Sau đó, tôi tự mặc quần áo. Tôi nói, “Mẹ ơi, bây giờ con đã lớn rồi.”
</h3></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt l1"><h3>
Ensuite, je m’habille, « Je suis grande maintenant maman, » dis-je.
</h3></div>
<div class="column col-1 col-lg-1 col-md-12 col-sm-12">
<div class="btn-group switcher-group">
<a href="#text08" class="btn btn-lg" title="Page précédente"><i class="icon-arrow-up"></i></a>
<a href="#text10" class="btn btn-lg" title="Page suivante"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton09" onclick="playpause('09')" title="lecture/pause"><i class="icon-volume-up"></i></button>
</div>
<div class="btn-group switcher-group">
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
</div>
</div>
<hr>
<div id="text10" class="columns">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/10.jpg"></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt def"><h3>
Tôi có thể xài nút áo và cột giày.
</h3></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt l1"><h3>
Je peux attacher mes boutons et boucler mes chaussures.
</h3></div>
<div class="column col-1 col-lg-1 col-md-12 col-sm-12">
<div class="btn-group switcher-group">
<a href="#text09" class="btn btn-lg" title="Page précédente"><i class="icon-arrow-up"></i></a>
<a href="#text11" class="btn btn-lg" title="Page suivante"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton10" onclick="playpause('10')" title="lecture/pause"><i class="icon-volume-up"></i></button>
</div>
<div class="btn-group switcher-group">
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
</div>
</div>
<hr>
<div id="text11" class="columns">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/11.jpg"></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt def"><h3>
Và tôi bảo đảm là em trai tôi biết hết tin tức trong trường.
</h3></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt l1"><h3>
Et je m’assure que mon petit frère connaît toutes les nouvelles de l’école.
</h3></div>
<div class="column col-1 col-lg-1 col-md-12 col-sm-12">
<div class="btn-group switcher-group">
<a href="#text10" class="btn btn-lg" title="Page précédente"><i class="icon-arrow-up"></i></a>
<a href="#text12" class="btn btn-lg" title="Page suivante"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton11" onclick="playpause('11')" title="lecture/pause"><i class="icon-volume-up"></i></button>
</div>
<div class="btn-group switcher-group">
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
</div>
</div>
<hr>
<div id="text12" class="columns">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/12.jpg"></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt def"><h3>
Mỗi ngày trong lớp, tôi đều cố gắng hết sức.
</h3></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt l1"><h3>
En classe je fais de mon mieux de toutes les façons possibles.
</h3></div>
<div class="column col-1 col-lg-1 col-md-12 col-sm-12">
<div class="btn-group switcher-group">
<a href="#text11" class="btn btn-lg" title="Page précédente"><i class="icon-arrow-up"></i></a>
<a href="#text13" class="btn btn-lg" title="Page suivante"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton12" onclick="playpause('12')" title="lecture/pause"><i class="icon-volume-up"></i></button>
</div>
<div class="btn-group switcher-group">
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
</div>
</div>
<hr>
<div id="text13" class="columns">
<div class="column col-5 col-lg-12 col-md-12 col-sm-12"><img class="img-responsive" src="https://raw.githubusercontent.com/global-asp/gsn-imagebank/master/0095/13.jpg"></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt def"><h3>
Mỗi ngày tôi đều làm những điều tốt này. Nhưng điều mà tôi thích nhất là chơi!
</h3></div>
<div class="column col-6 col-lg-11 col-md-12 col-sm-12 level2-txt l1"><h3>
Je fais toutes ces bonnes choses chaque jour. Mais la chose que j’aime le mieux, c’est de jouer et jouer encore!
</h3></div>
<div class="column col-1 col-lg-1 col-md-12 col-sm-12">
<div class="btn-group switcher-group">
<a href="#text12" class="btn btn-lg" title="Page précédente"><i class="icon-arrow-up"></i></a>
<a href="#colophon" class="btn btn-lg" title="Crédits à l’écriture"><i class="icon-arrow-down"></i></a>
<button class="btn btn-lg disabled" id="playbutton13" onclick="playpause('13')" title="lecture/pause"><i class="icon-volume-up"></i></button>
</div>
<div class="btn-group switcher-group">
<button onclick="switchlang('vi,fr','fr,vi')" class="btn btn-lg lang-primary" title="Passer de vietnamien à français">fr</button>
</div>
</div>
</div>
<hr>
<div id="colophon" class="columns">
<div class="column col-7 col-lg-12 col-md-12 col-sm-12">
<h5><span class="colophon-heading">Écrit par:</span> Michael Oguttu</h5>
<h5><span class="colophon-heading">Illustré par:</span> Vusi Malindi</h5>
<h5><span class="colophon-heading">Traduit par:</span> Phuong Nguyen</h5>
<h5><span class="colophon-heading">Langue:</span> <a href="/storybooks-fsl/stories/vi">vietnamien</a></h5>
<h5><span class="colophon-heading">Niveau:</span> <a href="/storybooks-fsl/stories/vi/level2">Niveau 2</a></h5>
<h5><span class="colophon-heading">Source:</span> <a href="https://africanstorybook.org/reader.php?id=9984" target="_blank">Zama is great!</a> du <a href="https://africanstorybook.org/">Livre de contes africains</a></h5>
<div><a rel="license" href="https://creativecommons.org/licenses/by/3.0/deed.fr" target="_blank"><img alt="Licence de Creative Commons " style="border-width:0" src="https://i.creativecommons.org/l/by/3.0/88x31.png" /></a><br />Ce travail est autorisé sous une licence <a rel="license" href="https://creativecommons.org/licenses/by/3.0/deed.fr" target="_blank">Creative Commons Attribution 3.0 non transposé</a>.</div>
</div>
<div class="column col-5 col-lg-12 col-md-12 col-sm-12">
<h5>Lire plus de contes de <a href="/storybooks-fsl/stories/vi/level2">niveau 2</a> :
</h5>
<label class="chip"><a href="/storybooks-fsl/stories/vi/0337/">Những đứa trẻ bằng sáp</a></label>
<label class="chip"><a href="/storybooks-fsl/stories/vi/0111/">Vì sao hà mã không có lông</a></label>
<label class="chip"><a href="/storybooks-fsl/stories/vi/0089/">Khalai trò chuyện cùng cây</a></label>
<label class="chip"><a href="/storybooks-fsl/stories/vi/0027/">Quyết định</a></label>
<label class="chip"><a href="/storybooks-fsl/stories/vi/0296/">Tom, người bán chuối</a></label>
<label class="chip"><a href="/storybooks-fsl/stories/vi/0210/">Tingi và đàn bò</a></label>
<label class="chip"><a href="/storybooks-fsl/stories/vi/0342/">Hình phạt</a></label>
<label class="chip"><a href="/storybooks-fsl/stories/vi/0004/">Dê, Chó, và Bò</a></label>
<label class="chip"><a href="/storybooks-fsl/stories/vi/0234/">Andiswa - Ngôi sao bóng đá</a></label>
<label class="chip"><a href="/storybooks-fsl/stories/vi/0001/">Anh chàng cao kều</a></label>
</div>
</div>
<div>
<h5>Options</h5>
<a class="btn btn-lg" href="/storybooks-fsl/stories/vi" class="button">Retour à la liste des contes</a> <span class="tooltip tooltip-top" data-tooltip="Le téléchargement PDF de ce conte est actuellement indisponible"><a class="btn btn-lg disabled">Téléchargement PDF</a></span>
<br><br>
</div>
</div>
</body>
</html>
|
<!DOCTYPE html>
<html lang="en">
<head>
<title>soengsouy.com</title>
<!-- Meta -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimal-ui">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="description" content="#">
<meta name="keywords" content="Admin , Responsive, Landing, Bootstrap, App, Template, Mobile, iOS, Android, apple, creative app">
<meta name="author" content="#">
<!-- Favicon icon -->
<link rel="icon" href="..\files\assets\images\favicon.ico" type="image/x-icon">
<!-- Google font-->
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,600,800" rel="stylesheet">
<!-- Required Fremwork -->
<link rel="stylesheet" type="text/css" href="..\files\bower_components\bootstrap\css\bootstrap.min.css">
<!-- themify-icons line icon -->
<link rel="stylesheet" type="text/css" href="..\files\assets\icon\themify-icons\themify-icons.css">
<!-- ico font -->
<link rel="stylesheet" type="text/css" href="..\files\assets\icon\icofont\css\icofont.css">
<!-- feather Awesome -->
<link rel="stylesheet" type="text/css" href="..\files\assets\icon\feather\css\feather.css">
<!-- Syntax highlighter Prism css -->
<link rel="stylesheet" type="text/css" href="..\files\assets\pages\prism\prism.css">
<!-- Style.css -->
<link rel="stylesheet" type="text/css" href="..\files\assets\css\style.css">
<link rel="stylesheet" type="text/css" href="..\files\assets\css\jquery.mCustomScrollbar.css">
</head>
<body>
<!-- Pre-loader start -->
<div class="theme-loader">
<div class="ball-scale">
<div class='contain'>
<div class="ring">
<div class="frame"></div>
</div>
<div class="ring">
<div class="frame"></div>
</div>
<div class="ring">
<div class="frame"></div>
</div>
<div class="ring">
<div class="frame"></div>
</div>
<div class="ring">
<div class="frame"></div>
</div>
<div class="ring">
<div class="frame"></div>
</div>
<div class="ring">
<div class="frame"></div>
</div>
<div class="ring">
<div class="frame"></div>
</div>
<div class="ring">
<div class="frame"></div>
</div>
<div class="ring">
<div class="frame"></div>
</div>
</div>
</div>
</div>
<!-- Pre-loader end -->
<!-- Menu header start -->
<div id="pcoded" class="pcoded">
<div class="pcoded-overlay-box"></div>
<div class="pcoded-container navbar-wrapper">
<nav class="navbar header-navbar pcoded-header">
<div class="navbar-wrapper">
<div class="navbar-logo">
<a class="mobile-menu" id="mobile-collapse" href="#!">
<i class="feather icon-menu"></i>
</a>
<a href="index-1.htm">
<img class="img-fluid" src="..\files\assets\images\logo.png" alt="Theme-Logo">
</a>
<a class="mobile-options">
<i class="feather icon-more-horizontal"></i>
</a>
</div>
<div class="navbar-container container-fluid">
<ul class="nav-left">
<li class="header-search">
<div class="main-search morphsearch-search">
<div class="input-group">
<span class="input-group-addon search-close"><i class="feather icon-x"></i></span>
<input type="text" class="form-control">
<span class="input-group-addon search-btn"><i class="feather icon-search"></i></span>
</div>
</div>
</li>
<li>
<a href="#!" onclick="javascript:toggleFullScreen()">
<i class="feather icon-maximize full-screen"></i>
</a>
</li>
</ul>
<ul class="nav-right">
<li class="header-notification">
<div class="dropdown-primary dropdown">
<div class="dropdown-toggle" data-toggle="dropdown">
<i class="feather icon-bell"></i>
<span class="badge bg-c-pink">5</span>
</div>
<ul class="show-notification notification-view dropdown-menu" data-dropdown-in="fadeIn" data-dropdown-out="fadeOut">
<li>
<h6>Notifications</h6>
<label class="label label-danger">New</label>
</li>
<li>
<div class="media">
<img class="d-flex align-self-center img-radius" src="..\files\assets\images\avatar-4.jpg" alt="Generic placeholder image">
<div class="media-body">
<h5 class="notification-user">Soeng Souy</h5>
<p class="notification-msg">Lorem ipsum dolor sit amet, consectetuer elit.</p>
<span class="notification-time">30 minutes ago</span>
</div>
</div>
</li>
<li>
<div class="media">
<img class="d-flex align-self-center img-radius" src="..\files\assets\images\avatar-3.jpg" alt="Generic placeholder image">
<div class="media-body">
<h5 class="notification-user">Joseph William</h5>
<p class="notification-msg">Lorem ipsum dolor sit amet, consectetuer elit.</p>
<span class="notification-time">30 minutes ago</span>
</div>
</div>
</li>
<li>
<div class="media">
<img class="d-flex align-self-center img-radius" src="..\files\assets\images\avatar-4.jpg" alt="Generic placeholder image">
<div class="media-body">
<h5 class="notification-user">Sara Soudein</h5>
<p class="notification-msg">Lorem ipsum dolor sit amet, consectetuer elit.</p>
<span class="notification-time">30 minutes ago</span>
</div>
</div>
</li>
</ul>
</div>
</li>
<li class="header-notification">
<div class="dropdown-primary dropdown">
<div class="displayChatbox dropdown-toggle" data-toggle="dropdown">
<i class="feather icon-message-square"></i>
<span class="badge bg-c-green">3</span>
</div>
</div>
</li>
<li class="user-profile header-notification">
<div class="dropdown-primary dropdown">
<div class="dropdown-toggle" data-toggle="dropdown">
<img src="..\files\assets\images\avatar-4.jpg" class="img-radius" alt="User-Profile-Image">
<span>Soeng Souy</span>
<i class="feather icon-chevron-down"></i>
</div>
<ul class="show-notification profile-notification dropdown-menu" data-dropdown-in="fadeIn" data-dropdown-out="fadeOut">
<li>
<a href="#!">
<i class="feather icon-settings"></i> Settings
</a>
</li>
<li>
<a href="user-profile.htm">
<i class="feather icon-user"></i> Profile
</a>
</li>
<li>
<a href="email-inbox.htm">
<i class="feather icon-mail"></i> My Messages
</a>
</li>
<li>
<a href="auth-lock-screen.htm">
<i class="feather icon-lock"></i> Lock Screen
</a>
</li>
<li>
<a href="auth-normal-sign-in.htm">
<i class="feather icon-log-out"></i> Logout
</a>
</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
</nav>
<!-- Sidebar chat start -->
<div id="sidebar" class="users p-chat-user showChat">
<div class="had-container">
<div class="card card_main p-fixed users-main">
<div class="user-box">
<div class="chat-inner-header">
<div class="back_chatBox">
<div class="right-icon-control">
<input type="text" class="form-control search-text" placeholder="Search Friend" id="search-friends">
<div class="form-icon">
<i class="icofont icofont-search"></i>
</div>
</div>
</div>
</div>
<div class="main-friend-list">
<div class="media userlist-box" data-id="1" data-status="online" data-username="Josephin Doe" data-toggle="tooltip" data-placement="left" title="Josephin Doe">
<a class="media-left" href="#!">
<img class="media-object img-radius img-radius" src="..\files\assets\images\avatar-3.jpg" alt="Generic placeholder image ">
<div class="live-status bg-success"></div>
</a>
<div class="media-body">
<div class="f-13 chat-header">Josephin Doe</div>
</div>
</div>
<div class="media userlist-box" data-id="2" data-status="online" data-username="Lary Doe" data-toggle="tooltip" data-placement="left" title="Lary Doe">
<a class="media-left" href="#!">
<img class="media-object img-radius" src="..\files\assets\images\avatar-2.jpg" alt="Generic placeholder image">
<div class="live-status bg-success"></div>
</a>
<div class="media-body">
<div class="f-13 chat-header">Lary Doe</div>
</div>
</div>
<div class="media userlist-box" data-id="3" data-status="online" data-username="Alice" data-toggle="tooltip" data-placement="left" title="Alice">
<a class="media-left" href="#!">
<img class="media-object img-radius" src="..\files\assets\images\avatar-4.jpg" alt="Generic placeholder image">
<div class="live-status bg-success"></div>
</a>
<div class="media-body">
<div class="f-13 chat-header">Alice</div>
</div>
</div>
<div class="media userlist-box" data-id="4" data-status="online" data-username="Alia" data-toggle="tooltip" data-placement="left" title="Alia">
<a class="media-left" href="#!">
<img class="media-object img-radius" src="..\files\assets\images\avatar-3.jpg" alt="Generic placeholder image">
<div class="live-status bg-success"></div>
</a>
<div class="media-body">
<div class="f-13 chat-header">Alia</div>
</div>
</div>
<div class="media userlist-box" data-id="5" data-status="online" data-username="Suzen" data-toggle="tooltip" data-placement="left" title="Suzen">
<a class="media-left" href="#!">
<img class="media-object img-radius" src="..\files\assets\images\avatar-2.jpg" alt="Generic placeholder image">
<div class="live-status bg-success"></div>
</a>
<div class="media-body">
<div class="f-13 chat-header">Suzen</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<!-- Sidebar inner chat start-->
<div class="showChat_inner">
<div class="media chat-inner-header">
<a class="back_chatBox">
<i class="feather icon-chevron-left"></i> Josephin Doe
</a>
</div>
<div class="media chat-messages">
<a class="media-left photo-table" href="#!">
<img class="media-object img-radius img-radius m-t-5" src="..\files\assets\images\avatar-3.jpg" alt="Generic placeholder image">
</a>
<div class="media-body chat-menu-content">
<div class="">
<p class="chat-cont">I'm just looking around. Will you tell me something about yourself?</p>
<p class="chat-time">8:20 a.m.</p>
</div>
</div>
</div>
<div class="media chat-messages">
<div class="media-body chat-menu-reply">
<div class="">
<p class="chat-cont">I'm just looking around. Will you tell me something about yourself?</p>
<p class="chat-time">8:20 a.m.</p>
</div>
</div>
<div class="media-right photo-table">
<a href="#!">
<img class="media-object img-radius img-radius m-t-5" src="..\files\assets\images\avatar-4.jpg" alt="Generic placeholder image">
</a>
</div>
</div>
<div class="chat-reply-box p-b-20">
<div class="right-icon-control">
<input type="text" class="form-control search-text" placeholder="Share Your Thoughts">
<div class="form-icon">
<i class="feather icon-navigation"></i>
</div>
</div>
</div>
</div>
<!-- Sidebar inner chat end-->
<div class="pcoded-main-container">
<div class="pcoded-wrapper">
<nav class="pcoded-navbar">
<div class="pcoded-inner-navbar main-menu">
<div class="pcoded-navigatio-lavel">Navigation</div>
<ul class="pcoded-item pcoded-left-item">
<li class="pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-home"></i></span>
<span class="pcoded-mtext">Dashboard</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="index-1.htm">
<span class="pcoded-mtext">Default</span>
</a>
</li>
<li class="">
<a href="dashboard-crm.htm">
<span class="pcoded-mtext">CRM</span>
</a>
</li>
<li class=" ">
<a href="dashboard-analytics.htm">
<span class="pcoded-mtext">Analytics</span>
<span class="pcoded-badge label label-info ">NEW</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu active pcoded-trigger">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-sidebar"></i></span>
<span class="pcoded-mtext">Page layouts</span>
<span class="pcoded-badge label label-warning">NEW</span>
</a>
<ul class="pcoded-submenu">
<li class=" pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-mtext">Vertical</span>
</a>
<ul class="pcoded-submenu">
<li class=" ">
<a href="menu-static.htm">
<span class="pcoded-mtext">Static Layout</span>
</a>
</li>
<li class=" ">
<a href="menu-header-fixed.htm">
<span class="pcoded-mtext">Header Fixed</span>
</a>
</li>
<li class=" ">
<a href="menu-compact.htm">
<span class="pcoded-mtext">Compact</span>
</a>
</li>
<li class=" ">
<a href="menu-sidebar.htm">
<span class="pcoded-mtext">Sidebar Fixed</span>
</a>
</li>
</ul>
</li>
<li class=" pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-mtext">Horizontal</span>
</a>
<ul class="pcoded-submenu">
<li class=" ">
<a href="menu-horizontal-static.htm" target="_blank">
<span class="pcoded-mtext">Static Layout</span>
</a>
</li>
<li class=" ">
<a href="menu-horizontal-fixed.htm" target="_blank">
<span class="pcoded-mtext">Fixed layout</span>
</a>
</li>
<li class=" ">
<a href="menu-horizontal-icon.htm" target="_blank">
<span class="pcoded-mtext">Static With Icon</span>
</a>
</li>
<li class=" ">
<a href="menu-horizontal-icon-fixed.htm" target="_blank">
<span class="pcoded-mtext">Fixed With Icon</span>
</a>
</li>
</ul>
</li>
<li class=" ">
<a href="menu-bottom.htm">
<span class="pcoded-mtext">Bottom Menu</span>
</a>
</li>
<li class="active">
<a href="box-layout.htm" target="_blank">
<span class="pcoded-mtext">Box Layout</span>
</a>
</li>
<li class=" ">
<a href="menu-rtl.htm" target="_blank">
<span class="pcoded-mtext">RTL</span>
</a>
</li>
</ul>
</li>
<li class="">
<a href="navbar-light.htm">
<span class="pcoded-micon"><i class="feather icon-menu"></i></span>
<span class="pcoded-mtext">Navigation</span>
</a>
</li>
<li class="pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-layers"></i></span>
<span class="pcoded-mtext">Widget</span>
<span class="pcoded-badge label label-danger">100+</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="widget-statistic.htm">
<span class="pcoded-mtext">Statistic</span>
</a>
</li>
<li class=" ">
<a href="widget-data.htm">
<span class="pcoded-mtext">Data</span>
</a>
</li>
<li class="">
<a href="widget-chart.htm">
<span class="pcoded-mtext">Chart Widget</span>
</a>
</li>
</ul>
</li>
</ul>
<div class="pcoded-navigatio-lavel">UI Element</div>
<ul class="pcoded-item pcoded-left-item">
<li class="pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-box"></i></span>
<span class="pcoded-mtext">Basic Components</span>
</a>
<ul class="pcoded-submenu">
<li class=" ">
<a href="alert.htm">
<span class="pcoded-mtext">Alert</span>
</a>
</li>
<li class=" ">
<a href="breadcrumb.htm">
<span class="pcoded-mtext">Breadcrumbs</span>
</a>
</li>
<li class=" ">
<a href="button.htm">
<span class="pcoded-mtext">Button</span>
</a>
</li>
<li class=" ">
<a href="box-shadow.htm">
<span class="pcoded-mtext">Box-Shadow</span>
</a>
</li>
<li class=" ">
<a href="accordion.htm">
<span class="pcoded-mtext">Accordion</span>
</a>
</li>
<li class=" ">
<a href="generic-class.htm">
<span class="pcoded-mtext">Generic Class</span>
</a>
</li>
<li class=" ">
<a href="tabs.htm">
<span class="pcoded-mtext">Tabs</span>
</a>
</li>
<li class=" ">
<a href="color.htm">
<span class="pcoded-mtext">Color</span>
</a>
</li>
<li class=" ">
<a href="label-badge.htm">
<span class="pcoded-mtext">Label Badge</span>
</a>
</li>
<li class=" ">
<a href="progress-bar.htm">
<span class="pcoded-mtext">Progress Bar</span>
</a>
</li>
<li class=" ">
<a href="preloader.htm">
<span class="pcoded-mtext">Pre-Loader</span>
</a>
</li>
<li class=" ">
<a href="list.htm">
<span class="pcoded-mtext">List</span>
</a>
</li>
<li class=" ">
<a href="tooltip.htm">
<span class="pcoded-mtext">Tooltip And Popover</span>
</a>
</li>
<li class=" ">
<a href="typography.htm">
<span class="pcoded-mtext">Typography</span>
</a>
</li>
<li class=" ">
<a href="other.htm">
<span class="pcoded-mtext">Other</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-gitlab"></i></span>
<span class="pcoded-mtext">Advance Components</span>
</a>
<ul class="pcoded-submenu">
<li class=" ">
<a href="draggable.htm">
<span class="pcoded-mtext">Draggable</span>
</a>
</li>
<li class=" ">
<a href="bs-grid.htm">
<span class="pcoded-mtext">Grid Stack</span>
</a>
</li>
<li class=" ">
<a href="light-box.htm">
<span class="pcoded-mtext">Light Box</span>
</a>
</li>
<li class=" ">
<a href="modal.htm">
<span class="pcoded-mtext">Modal</span>
</a>
</li>
<li class=" ">
<a href="notification.htm">
<span class="pcoded-mtext">Notifications</span>
</a>
</li>
<li class=" ">
<a href="notify.htm">
<span class="pcoded-mtext">PNOTIFY</span>
<span class="pcoded-badge label label-info">NEW</span>
</a>
</li>
<li class=" ">
<a href="rating.htm">
<span class="pcoded-mtext">Rating</span>
</a>
</li>
<li class=" ">
<a href="range-slider.htm">
<span class="pcoded-mtext">Range Slider</span>
</a>
</li>
<li class=" ">
<a href="slider.htm">
<span class="pcoded-mtext">Slider</span>
</a>
</li>
<li class=" ">
<a href="syntax-highlighter.htm">
<span class="pcoded-mtext">Syntax Highlighter</span>
</a>
</li>
<li class=" ">
<a href="tour.htm">
<span class="pcoded-mtext">Tour</span>
</a>
</li>
<li class=" ">
<a href="treeview.htm">
<span class="pcoded-mtext">Tree View</span>
</a>
</li>
<li class=" ">
<a href="nestable.htm">
<span class="pcoded-mtext">Nestable</span>
</a>
</li>
<li class=" ">
<a href="toolbar.htm">
<span class="pcoded-mtext">Toolbar</span>
</a>
</li>
<li class=" ">
<a href="x-editable.htm">
<span class="pcoded-mtext">X-Editable</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-package"></i></span>
<span class="pcoded-mtext">Extra Components</span>
</a>
<ul class="pcoded-submenu">
<li class=" ">
<a href="session-timeout.htm">
<span class="pcoded-mtext">Session Timeout</span>
</a>
</li>
<li class=" ">
<a href="session-idle-timeout.htm">
<span class="pcoded-mtext">Session Idle Timeout</span>
</a>
</li>
<li class=" ">
<a href="offline.htm">
<span class="pcoded-mtext">Offline</span>
</a>
</li>
</ul>
</li>
<li class=" ">
<a href="animation.htm">
<span class="pcoded-micon"><i class="feather icon-aperture rotate-refresh"></i><b>A</b></span>
<span class="pcoded-mtext">Animations</span>
</a>
</li>
<li class=" ">
<a href="sticky.htm">
<span class="pcoded-micon"><i class="feather icon-cpu"></i></span>
<span class="pcoded-mtext">Sticky Notes</span>
<span class="pcoded-badge label label-danger">HOT</span>
</a>
</li>
<li class="pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-command"></i></span>
<span class="pcoded-mtext">Icons</span>
</a>
<ul class="pcoded-submenu">
<li class=" ">
<a href="icon-font-awesome.htm">
<span class="pcoded-mtext">Font Awesome</span>
</a>
</li>
<li class=" ">
<a href="icon-themify.htm">
<span class="pcoded-mtext">Themify</span>
</a>
</li>
<li class=" ">
<a href="icon-simple-line.htm">
<span class="pcoded-mtext">Simple Line Icon</span>
</a>
</li>
<li class=" ">
<a href="icon-ion.htm">
<span class="pcoded-mtext">Ion Icon</span>
</a>
</li>
<li class=" ">
<a href="icon-material-design.htm">
<span class="pcoded-mtext">Material Design</span>
</a>
</li>
<li class=" ">
<a href="icon-icofonts.htm">
<span class="pcoded-mtext">Ico Fonts</span>
</a>
</li>
<li class=" ">
<a href="icon-weather.htm">
<span class="pcoded-mtext">Weather Icon</span>
</a>
</li>
<li class=" ">
<a href="icon-typicons.htm">
<span class="pcoded-mtext">Typicons</span>
</a>
</li>
<li class=" ">
<a href="icon-flags.htm">
<span class="pcoded-mtext">Flags</span>
</a>
</li>
</ul>
</li>
</ul>
<div class="pcoded-navigatio-lavel">Forms</div>
<ul class="pcoded-item pcoded-left-item">
<li class="pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-clipboard"></i></span>
<span class="pcoded-mtext">Form Components</span>
</a>
<ul class="pcoded-submenu">
<li class=" ">
<a href="form-elements-component.htm">
<span class="pcoded-mtext">Form Components</span>
</a>
</li>
<li class=" ">
<a href="form-elements-add-on.htm">
<span class="pcoded-mtext">Form-Elements-Add-On</span>
</a>
</li>
<li class=" ">
<a href="form-elements-advance.htm">
<span class="pcoded-mtext">Form-Elements-Advance</span>
</a>
</li>
<li class=" ">
<a href="form-validation.htm">
<span class="pcoded-mtext">Form Validation</span>
</a>
</li>
</ul>
</li>
<li class=" ">
<a href="form-picker.htm">
<span class="pcoded-micon"><i class="feather icon-edit-1"></i></span>
<span class="pcoded-mtext">Form Picker</span>
<span class="pcoded-badge label label-warning">NEW</span>
</a>
</li>
<li class=" ">
<a href="form-select.htm">
<span class="pcoded-micon"><i class="feather icon-feather"></i></span>
<span class="pcoded-mtext">Form Select</span>
</a>
</li>
<li class=" ">
<a href="form-masking.htm">
<span class="pcoded-micon"><i class="feather icon-shield"></i></span>
<span class="pcoded-mtext">Form Masking</span>
</a>
</li>
<li class=" ">
<a href="form-wizard.htm">
<span class="pcoded-micon"><i class="feather icon-tv"></i></span>
<span class="pcoded-mtext">Form Wizard</span>
</a>
</li>
<li class="pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-book"></i></span>
<span class="pcoded-mtext">Ready To Use</span>
<span class="pcoded-badge label label-danger">HOT</span>
</a>
<ul class="pcoded-submenu">
<li class=" ">
<a href="ready-cloned-elements-form.htm">
<span class="pcoded-mtext">Cloned Elements Form</span>
</a>
</li>
<li class=" ">
<a href="ready-currency-form.htm">
<span class="pcoded-mtext">Currency Form</span>
</a>
</li>
<li class=" ">
<a href="ready-form-booking.htm">
<span class="pcoded-mtext">Booking Form</span>
</a>
</li>
<li class=" ">
<a href="ready-form-booking-multi-steps.htm">
<span class="pcoded-mtext">Booking Multi Steps Form</span>
</a>
</li>
<li class=" ">
<a href="ready-form-comment.htm">
<span class="pcoded-mtext">Comment Form</span>
</a>
</li>
<li class=" ">
<a href="ready-form-contact.htm">
<span class="pcoded-mtext">Contact Form</span>
</a>
</li>
<li class=" ">
<a href="ready-job-application-form.htm">
<span class="pcoded-mtext">Job Application Form</span>
</a>
</li>
<li class=" ">
<a href="ready-js-addition-form.htm">
<span class="pcoded-mtext">JS Addition Form</span>
</a>
</li>
<li class=" ">
<a href="ready-login-form.htm">
<span class="pcoded-mtext">Login Form</span>
</a>
</li>
<li class=" ">
<a href="ready-popup-modal-form.htm" target="_blank">
<span class="pcoded-mtext">Popup Modal Form</span>
</a>
</li>
<li class=" ">
<a href="ready-registration-form.htm">
<span class="pcoded-mtext">Registration Form</span>
</a>
</li>
<li class=" ">
<a href="ready-review-form.htm">
<span class="pcoded-mtext">Review Form</span>
</a>
</li>
<li class=" ">
<a href="ready-subscribe-form.htm">
<span class="pcoded-mtext">Subscribe Form</span>
</a>
</li>
<li class=" ">
<a href="ready-suggestion-form.htm">
<span class="pcoded-mtext">Suggestion Form</span>
</a>
</li>
<li class=" ">
<a href="ready-tabs-form.htm">
<span class="pcoded-mtext">Tabs Form</span>
</a>
</li>
</ul>
</li>
</ul>
<div class="pcoded-navigatio-lavel">Tables</div>
<ul class="pcoded-item pcoded-left-item">
<li class="pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-credit-card"></i></span>
<span class="pcoded-mtext">Bootstrap Table</span>
</a>
<ul class="pcoded-submenu">
<li class=" ">
<a href="bs-basic-table.htm">
<span class="pcoded-mtext">Basic Table</span>
</a>
</li>
<li class=" ">
<a href="bs-table-sizing.htm">
<span class="pcoded-mtext">Sizing Table</span>
</a>
</li>
<li class=" ">
<a href="bs-table-border.htm">
<span class="pcoded-mtext">Border Table</span>
</a>
</li>
<li class=" ">
<a href="bs-table-styling.htm">
<span class="pcoded-mtext">Styling Table</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-inbox"></i></span>
<span class="pcoded-mtext">Data Table</span>
<span class="pcoded-mcaret"></span>
</a>
<ul class="pcoded-submenu">
<li class=" ">
<a href="dt-basic.htm">
<span class="pcoded-mtext">Basic Initialization</span>
</a>
</li>
<li class=" ">
<a href="dt-advance.htm">
<span class="pcoded-mtext">Advance Initialization</span>
</a>
</li>
<li class=" ">
<a href="dt-styling.htm">
<span class="pcoded-mtext">Styling</span>
</a>
</li>
<li class=" ">
<a href="dt-api.htm">
<span class="pcoded-mtext">API</span>
</a>
</li>
<li class=" ">
<a href="dt-ajax.htm">
<span class="pcoded-mtext">Ajax</span>
</a>
</li>
<li class=" ">
<a href="dt-server-side.htm">
<span class="pcoded-mtext">Server Side</span>
</a>
</li>
<li class=" ">
<a href="dt-plugin.htm">
<span class="pcoded-mtext">Plug-In</span>
</a>
</li>
<li class=" ">
<a href="dt-data-sources.htm">
<span class="pcoded-mtext">Data Sources</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-server"></i></span>
<span class="pcoded-mtext">Data Table Extensions</span>
</a>
<ul class="pcoded-submenu">
<li class=" ">
<a href="dt-ext-autofill.htm">
<span class="pcoded-mtext">AutoFill</span>
</a>
</li>
<li class="pcoded-hasmenu">
<a href="javascript:void(0)">
<span class="pcoded-mtext">Button</span>
</a>
<ul class="pcoded-submenu">
<li class=" ">
<a href="dt-ext-basic-buttons.htm">
<span class="pcoded-mtext">Basic Button</span>
</a>
</li>
<li class=" ">
<a href="dt-ext-buttons-html-5-data-export.htm">
<span class="pcoded-mtext">Html-5 Data Export</span>
</a>
</li>
</ul>
</li>
<li class=" ">
<a href="dt-ext-col-reorder.htm">
<span class="pcoded-mtext">Col Reorder</span>
</a>
</li>
<li class=" ">
<a href="dt-ext-fixed-columns.htm">
<span class="pcoded-mtext">Fixed Columns</span>
</a>
</li>
<li class=" ">
<a href="dt-ext-fixed-header.htm">
<span class="pcoded-mtext">Fixed Header</span>
</a>
</li>
<li class=" ">
<a href="dt-ext-key-table.htm">
<span class="pcoded-mtext">Key Table</span>
</a>
</li>
<li class=" ">
<a href="dt-ext-responsive.htm">
<span class="pcoded-mtext">Responsive</span>
</a>
</li>
<li class=" ">
<a href="dt-ext-row-reorder.htm">
<span class="pcoded-mtext">Row Reorder</span>
</a>
</li>
<li class=" ">
<a href="dt-ext-scroller.htm">
<span class="pcoded-mtext">Scroller</span>
</a>
</li>
<li class=" ">
<a href="dt-ext-select.htm">
<span class="pcoded-mtext">Select Table</span>
</a>
</li>
</ul>
</li>
<li class=" ">
<a href="foo-table.htm">
<span class="pcoded-micon"><i class="feather icon-hash"></i></span>
<span class="pcoded-mtext">FooTable</span>
</a>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-airplay"></i></span>
<span class="pcoded-mtext">Handson Table</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="handson-appearance.htm">
<span class="pcoded-mtext">Appearance</span>
</a>
</li>
<li class="">
<a href="handson-data-operation.htm">
<span class="pcoded-mtext">Data Operation</span>
</a>
</li>
<li class="">
<a href="handson-rows-cols.htm">
<span class="pcoded-mtext">Rows Columns</span>
</a>
</li>
<li class="">
<a href="handson-columns-only.htm">
<span class="pcoded-mtext">Columns Only</span>
</a>
</li>
<li class="">
<a href="handson-cell-features.htm">
<span class="pcoded-mtext">Cell Features</span>
</a>
</li>
<li class="">
<a href="handson-cell-types.htm">
<span class="pcoded-mtext">Cell Types</span>
</a>
</li>
<li class="">
<a href="handson-integrations.htm">
<span class="pcoded-mtext">Integrations</span>
</a>
</li>
<li class="">
<a href="handson-rows-only.htm">
<span class="pcoded-mtext">Rows Only</span>
</a>
</li>
<li class="">
<a href="handson-utilities.htm">
<span class="pcoded-mtext">Utilities</span>
</a>
</li>
</ul>
</li>
<li class="">
<a href="editable-table.htm">
<span class="pcoded-micon"><i class="feather icon-edit"></i></span>
<span class="pcoded-mtext">Editable Table</span>
</a>
</li>
</ul>
<div class="pcoded-navigatio-lavel">Chart And Maps</div>
<ul class="pcoded-item pcoded-left-item">
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-pie-chart"></i></span>
<span class="pcoded-mtext">Charts</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="chart-google.htm">
<span class="pcoded-mtext">Google Chart</span>
</a>
</li>
<li class="">
<a href="chart-echart.htm">
<span class="pcoded-mtext">Echarts</span>
</a>
</li>
<li class="">
<a href="chart-chartjs.htm">
<span class="pcoded-mtext">ChartJs</span>
</a>
</li>
<li class="">
<a href="chart-list.htm">
<span class="pcoded-mtext">List Chart</span>
</a>
</li>
<li class="">
<a href="chart-float.htm">
<span class="pcoded-mtext">Float Chart</span>
</a>
</li>
<li class="">
<a href="chart-knob.htm">
<span class="pcoded-mtext">Knob chart</span>
</a>
</li>
<li class="">
<a href="chart-morris.htm">
<span class="pcoded-mtext">Morris Chart</span>
</a>
</li>
<li class="">
<a href="chart-nvd3.htm">
<span class="pcoded-mtext">Nvd3 Chart</span>
</a>
</li>
<li class="">
<a href="chart-peity.htm">
<span class="pcoded-mtext">Peity Chart</span>
</a>
</li>
<li class="">
<a href="chart-radial.htm">
<span class="pcoded-mtext">Radial Chart</span>
</a>
</li>
<li class="">
<a href="chart-rickshaw.htm">
<span class="pcoded-mtext">Rickshaw Chart</span>
</a>
</li>
<li class="">
<a href="chart-sparkline.htm">
<span class="pcoded-mtext">Sparkline Chart</span>
</a>
</li>
<li class="">
<a href="chart-c3.htm">
<span class="pcoded-mtext">C3 Chart</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-map"></i></span>
<span class="pcoded-mtext">Maps</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="map-google.htm">
<span class="pcoded-mtext">Google Maps</span>
</a>
</li>
<li class="">
<a href="map-vector.htm">
<span class="pcoded-mtext">Vector Maps</span>
</a>
</li>
<li class="">
<a href="map-api.htm">
<span class="pcoded-mtext">Google Map Search API</span>
</a>
</li>
<li class="">
<a href="location.htm">
<span class="pcoded-mtext">Location</span>
</a>
</li>
</ul>
</li>
<li class="">
<a href="..\files\extra-pages\landingpage\index.htm" target="_blank">
<span class="pcoded-micon"><i class="feather icon-navigation-2"></i></span>
<span class="pcoded-mtext">Landing Page</span>
</a>
</li>
</ul>
<div class="pcoded-navigatio-lavel">Pages</div>
<ul class="pcoded-item pcoded-left-item">
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-unlock"></i></span>
<span class="pcoded-mtext">Authentication</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="auth-normal-sign-in.htm" target="_blank">
<span class="pcoded-mtext">Login With BG Image</span>
</a>
</li>
<li class="">
<a href="auth-sign-in-social.htm" target="_blank">
<span class="pcoded-mtext">Login With Social Icon</span>
</a>
</li>
<li class="">
<a href="auth-sign-in-social-header-footer.htm" target="_blank">
<span class="pcoded-mtext">Login Social With Header And Footer</span>
</a>
</li>
<li class="">
<a href="auth-normal-sign-in-header-footer.htm" target="_blank">
<span class="pcoded-mtext">Login With Header And Footer</span>
</a>
</li>
<li class="">
<a href="auth-sign-up.htm" target="_blank">
<span class="pcoded-mtext">Registration BG Image</span>
</a>
</li>
<li class="">
<a href="auth-sign-up-social.htm" target="_blank">
<span class="pcoded-mtext">Registration Social Icon</span>
</a>
</li>
<li class="">
<a href="auth-sign-up-social-header-footer.htm" target="_blank">
<span class="pcoded-mtext">Registration Social With Header And Footer</span>
</a>
</li>
<li class="">
<a href="auth-sign-up-header-footer.htm" target="_blank">
<span class="pcoded-mtext">Registration With Header And Footer</span>
</a>
</li>
<li class="">
<a href="auth-multi-step-sign-up.htm" target="_blank">
<span class="pcoded-mtext">Multi Step Registration</span>
</a>
</li>
<li class="">
<a href="auth-reset-password.htm" target="_blank">
<span class="pcoded-mtext">Forgot Password</span>
</a>
</li>
<li class="">
<a href="auth-lock-screen.htm" target="_blank">
<span class="pcoded-mtext">Lock Screen</span>
</a>
</li>
<li class="">
<a href="auth-modal.htm" target="_blank">
<span class="pcoded-mtext">Modal</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-sliders"></i></span>
<span class="pcoded-mtext">Maintenance</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="error.htm">
<span class="pcoded-mtext">Error</span>
</a>
</li>
<li class="">
<a href="comming-soon.htm">
<span class="pcoded-mtext">Comming Soon</span>
</a>
</li>
<li class="">
<a href="offline-ui.htm">
<span class="pcoded-mtext">Offline UI</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-users"></i></span>
<span class="pcoded-mtext">User Profile</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="timeline.htm">
<span class="pcoded-mtext">Timeline</span>
</a>
</li>
<li class="">
<a href="timeline-social.htm">
<span class="pcoded-mtext">Timeline Social</span>
</a>
</li>
<li class="">
<a href="user-profile.htm">
<span class="pcoded-mtext">User Profile</span>
</a>
</li>
<li class="">
<a href="user-card.htm">
<span class="pcoded-mtext">User Card</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-shopping-cart"></i></span>
<span class="pcoded-mtext">E-Commerce</span>
<span class="pcoded-badge label label-danger">NEW</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="product.htm">
<span class="pcoded-mtext">Product</span>
</a>
</li>
<li class="">
<a href="product-list.htm">
<span class="pcoded-mtext">Product List</span>
</a>
</li>
<li class="">
<a href="product-edit.htm">
<span class="pcoded-mtext">Product Edit</span>
</a>
</li>
<li class="">
<a href="product-detail.htm">
<span class="pcoded-mtext">Product Detail</span>
</a>
</li>
<li class="">
<a href="product-cart.htm">
<span class="pcoded-mtext">Product Card</span>
</a>
</li>
<li class="">
<a href="product-payment.htm">
<span class="pcoded-mtext">Credit Card Form</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-mail"></i></span>
<span class="pcoded-mtext">Email</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="email-compose.htm">
<span class="pcoded-mtext">Compose Email</span>
</a>
</li>
<li class="">
<a href="email-inbox.htm">
<span class="pcoded-mtext">Inbox</span>
</a>
</li>
<li class="">
<a href="email-read.htm">
<span class="pcoded-mtext">Read Mail</span>
</a>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-mtext">Email Template</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="..\files\extra-pages\email-templates\email-welcome.htm">
<span class="pcoded-mtext">Welcome Email</span>
</a>
</li>
<li class="">
<a href="..\files\extra-pages\email-templates\email-password.htm">
<span class="pcoded-mtext">Reset Password</span>
</a>
</li>
<li class="">
<a href="..\files\extra-pages\email-templates\email-newsletter.htm">
<span class="pcoded-mtext">Newsletter Email</span>
</a>
</li>
<li class="">
<a href="..\files\extra-pages\email-templates\email-launch.htm">
<span class="pcoded-mtext">App Launch</span>
</a>
</li>
<li class="">
<a href="..\files\extra-pages\email-templates\email-activation.htm">
<span class="pcoded-mtext">Activation Code</span>
</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="pcoded-navigatio-lavel">App</div>
<ul class="pcoded-item pcoded-left-item">
<li class=" ">
<a href="chat.htm">
<span class="pcoded-micon"><i class="feather icon-message-square"></i></span>
<span class="pcoded-mtext">Chat</span>
</a>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-globe"></i></span>
<span class="pcoded-mtext">Social</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="fb-wall.htm">
<span class="pcoded-mtext">Wall</span>
</a>
</li>
<li class="">
<a href="message.htm">
<span class="pcoded-mtext">Messages</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-check-circle"></i></span>
<span class="pcoded-mtext">Task</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="task-list.htm">
<span class="pcoded-mtext">Task List</span>
</a>
</li>
<li class="">
<a href="task-board.htm">
<span class="pcoded-mtext">Task Board</span>
</a>
</li>
<li class="">
<a href="task-detail.htm">
<span class="pcoded-mtext">Task Detail</span>
</a>
</li>
<li class="">
<a href="issue-list.htm">
<span class="pcoded-mtext">Issue List</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-bookmark"></i></span>
<span class="pcoded-mtext">To-Do</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="todo.htm">
<span class="pcoded-mtext">To-Do</span>
</a>
</li>
<li class="">
<a href="notes.htm">
<span class="pcoded-mtext">Notes</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-image"></i></span>
<span class="pcoded-mtext">Gallery</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="gallery-grid.htm">
<span class="pcoded-mtext">Gallery-Grid</span>
</a>
</li>
<li class="">
<a href="gallery-masonry.htm">
<span class="pcoded-mtext">Masonry Gallery</span>
</a>
</li>
<li class="">
<a href="gallery-advance.htm">
<span class="pcoded-mtext">Advance Gallery</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-search"></i><b>S</b></span>
<span class="pcoded-mtext">Search</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="search-result.htm">
<span class="pcoded-mtext">Simple Search</span>
</a>
</li>
<li class="">
<a href="search-result2.htm">
<span class="pcoded-mtext">Grouping Search</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-award"></i></span>
<span class="pcoded-mtext">Job Search</span>
<span class="pcoded-badge label label-danger">NEW</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="job-card-view.htm">
<span class="pcoded-mtext">Card View</span>
</a>
</li>
<li class="">
<a href="job-details.htm">
<span class="pcoded-mtext">Job Detailed</span>
</a>
</li>
<li class="">
<a href="job-find.htm">
<span class="pcoded-mtext">Job Find</span>
</a>
</li>
<li class="">
<a href="job-panel-view.htm">
<span class="pcoded-mtext">Job Panel View</span>
</a>
</li>
</ul>
</li>
</ul>
<div class="pcoded-navigatio-lavel">Extension</div>
<ul class="pcoded-item pcoded-left-item">
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-file-plus"></i></span>
<span class="pcoded-mtext">Editor</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="ck-editor.htm">
<span class="pcoded-mtext">CK-Editor</span>
</a>
</li>
<li class="">
<a href="wysiwyg-editor.htm">
<span class="pcoded-mtext">WYSIWYG Editor</span>
</a>
</li>
<li class="">
<a href="ace-editor.htm">
<span class="pcoded-mtext">Ace Editor</span>
</a>
</li>
<li class="">
<a href="long-press-editor.htm">
<span class="pcoded-mtext">Long Press Editor</span>
</a>
</li>
</ul>
</li>
</ul>
<ul class="pcoded-item pcoded-left-item">
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-file-minus"></i></span>
<span class="pcoded-mtext">Invoice</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="invoice.htm">
<span class="pcoded-mtext">Invoice</span>
</a>
</li>
<li class="">
<a href="invoice-summary.htm">
<span class="pcoded-mtext">Invoice Summary</span>
</a>
</li>
<li class="">
<a href="invoice-list.htm">
<span class="pcoded-mtext">Invoice List</span>
</a>
</li>
</ul>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-calendar"></i></span>
<span class="pcoded-mtext">Event Calendar</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="event-full-calender.htm">
<span class="pcoded-mtext">Full Calendar</span>
</a>
</li>
<li class="">
<a href="event-clndr.htm">
<span class="pcoded-mtext">CLNDER</span>
<span class="pcoded-badge label label-info">NEW</span>
</a>
</li>
</ul>
</li>
<li class="">
<a href="image-crop.htm">
<span class="pcoded-micon"><i class="feather icon-scissors"></i></span>
<span class="pcoded-mtext">Image Cropper</span>
</a>
</li>
<li class="">
<a href="file-upload.htm">
<span class="pcoded-micon"><i class="feather icon-upload-cloud"></i></span>
<span class="pcoded-mtext">File Upload</span>
</a>
</li>
<li class="">
<a href="change-loges.htm">
<span class="pcoded-micon"><i class="feather icon-briefcase"></i><b>CL</b></span>
<span class="pcoded-mtext">Change Loges</span>
</a>
</li>
</ul>
<div class="pcoded-navigatio-lavel">Other</div>
<ul class="pcoded-item pcoded-left-item">
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-micon"><i class="feather icon-list"></i></span>
<span class="pcoded-mtext">Menu Levels</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="javascript:void(0)">
<span class="pcoded-mtext">Menu Level 2.1</span>
</a>
</li>
<li class="pcoded-hasmenu ">
<a href="javascript:void(0)">
<span class="pcoded-mtext">Menu Level 2.2</span>
</a>
<ul class="pcoded-submenu">
<li class="">
<a href="javascript:void(0)">
<span class="pcoded-mtext">Menu Level 3.1</span>
</a>
</li>
</ul>
</li>
<li class="">
<a href="javascript:void(0)">
<span class="pcoded-mtext">Menu Level 2.3</span>
</a>
</li>
</ul>
</li>
<li class="">
<a href="javascript:void(0)" class="disabled">
<span class="pcoded-micon"><i class="feather icon-power"></i></span>
<span class="pcoded-mtext">Disabled Menu</span>
</a>
</li>
<li class="">
<a href="sample-page.htm">
<span class="pcoded-micon"><i class="feather icon-watch"></i></span>
<span class="pcoded-mtext">Sample Page</span>
</a>
</li>
</ul>
<div class="pcoded-navigatio-lavel">Support</div>
<ul class="pcoded-item pcoded-left-item">
<li class="">
<a href="http://html.codedthemes.com/Adminty/doc" target="_blank">
<span class="pcoded-micon"><i class="feather icon-monitor"></i></span>
<span class="pcoded-mtext">Documentation</span>
</a>
</li>
<li class="">
<a href="#" target="_blank">
<span class="pcoded-micon"><i class="feather icon-help-circle"></i></span>
<span class="pcoded-mtext">Submit Issue</span>
</a>
</li>
</ul>
</div>
</nav>
<div class="pcoded-content">
<div class="pcoded-inner-content">
<!-- Main-body start -->
<div class="main-body">
<div class="page-wrapper">
<!-- Page-header start -->
<div class="page-header horizontal-layout-icon">
<div class="row align-items-end">
<div class="col-sm-8">
<div class="page-header-title">
<div class="d-inline">
<h4>Box-layout</h4>
<span>lorem ipsum dolor sit amet, consectetur adipisicing elit</span>
</div>
</div>
</div>
<div class="col-sm-4">
<div class="page-header-breadcrumb">
<ul class="breadcrumb-title">
<li class="breadcrumb-item">
<a href="index-1.htm">
<i class="icofont icofont-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="#!">Page Layouts</a>
</li>
<li class="breadcrumb-item"><a href="#!">Box-Layout</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<!-- Page-header end -->
<!-- Page body start -->
<div class="page-body">
<div class="row">
<div class="col-lg-12">
<!-- Default card start -->
<div class="card">
<div class="card-block">
<span>Box-layout Menu layout is useful for those users who wants container or box-view of theme.</span>
</div>
</div>
<div class="card">
<div class="card-header">
<h5>JS Option</h5>
</div>
<div class="card-block">
<span>To use Compact Menu for your project add <code><strong>verticalMenulayout: 'box',</strong></code> class in js.</span>
</div>
</div>
<div class="card">
<div class="card-header">
<h5>HTML Markup</h5>
</div>
<div class="card-block">
<p>Use the following code to use <strong>Box-Layout Menu</strong> .</p>
<h6 class="m-t-20 f-w-600">Usage:</h6>
<pre> <code class="language-markup">
$( document ).ready(function() {
$( "#pcoded" ).pcodedmenu({
verticalMenulayout: 'box',
});
});
</code>
</pre>
</div>
</div>
<!-- Default card end -->
</div>
</div>
</div>
<!-- Page body end -->
</div>
</div>
<!-- Main-body end -->
<div id="styleSelector">
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<!-- Warning Section Starts -->
<!-- Older IE warning message -->
<!--[if lt IE 10]>
<div class="ie-warning">
<h1>Warning!!</h1>
<p>You are using an outdated version of Internet Explorer, please upgrade <br/>to any of the following web browsers
to access this website.</p>
<div class="iew-container">
<ul class="iew-download">
<li>
<a href="http://www.google.com/chrome/">
<img src="../files/assets/images/browser/chrome.png" alt="Chrome">
<div>Chrome</div>
</a>
</li>
<li>
<a href="https://www.mozilla.org/en-US/firefox/new/">
<img src="../files/assets/images/browser/firefox.png" alt="Firefox">
<div>Firefox</div>
</a>
</li>
<li>
<a href="http://www.opera.com">
<img src="../files/assets/images/browser/opera.png" alt="Opera">
<div>Opera</div>
</a>
</li>
<li>
<a href="https://www.apple.com/safari/">
<img src="../files/assets/images/browser/safari.png" alt="Safari">
<div>Safari</div>
</a>
</li>
<li>
<a href="http://windows.microsoft.com/en-us/internet-explorer/download-ie">
<img src="../files/assets/images/browser/ie.png" alt="">
<div>IE (9 & above)</div>
</a>
</li>
</ul>
</div>
<p>Sorry for the inconvenience!</p>
</div>
<![endif]-->
<!-- Warning Section Ends -->
<!-- Required Jquery -->
<script type="text/javascript" src="..\files\bower_components\jquery\js\jquery.min.js"></script>
<script type="text/javascript" src="..\files\bower_components\jquery-ui\js\jquery-ui.min.js"></script>
<script type="text/javascript" src="..\files\bower_components\popper.js\js\popper.min.js"></script>
<script type="text/javascript" src="..\files\bower_components\bootstrap\js\bootstrap.min.js"></script>
<!-- jquery slimscroll js -->
<script type="text/javascript" src="..\files\bower_components\jquery-slimscroll\js\jquery.slimscroll.js"></script>
<!-- modernizr js -->
<script type="text/javascript" src="..\files\bower_components\modernizr\js\modernizr.js"></script>
<script type="text/javascript" src="..\files\bower_components\modernizr\js\css-scrollbars.js"></script>
<!-- Syntax highlighter prism js -->
<script type="text/javascript" src="..\files\assets\pages\prism\custom-prism.js"></script>
<!-- Custom js -->
<script src="..\files\assets\js\pcoded.min.js"></script>
<script src="..\files\assets\js\menu\box-layout.js"></script>
<script src="..\files\assets\js\jquery.mCustomScrollbar.concat.min.js"></script>
<script type="text/javascript" src="..\files\assets\js\script.js"></script>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async="" src="https://www.googletagmanager.com/gtag/js?id=UA-23581568-13"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-23581568-13');
</script>
</body>
</html>
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_79) on Thu Dec 15 18:59:52 PST 2016 -->
<title>MultivariateGaussian (Spark 2.1.0 JavaDoc)</title>
<meta name="date" content="2016-12-15">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MultivariateGaussian (Spark 2.1.0 JavaDoc)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/spark/mllib/stat/distribution/MultivariateGaussian.html" target="_top">Frames</a></li>
<li><a href="MultivariateGaussian.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.spark.mllib.stat.distribution</div>
<h2 title="Class MultivariateGaussian" class="title">Class MultivariateGaussian</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.mllib.stat.distribution.MultivariateGaussian</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">MultivariateGaussian</span>
extends Object
implements scala.Serializable</pre>
<div class="block">:: DeveloperApi ::
This class provides basic functionality for a Multivariate Gaussian (Normal) Distribution. In
the event that the covariance matrix is singular, the density will be computed in a
reduced dimensional subspace under which the distribution is supported.
(see <a href="http://en.wikipedia.org/wiki/Multivariate_normal_distribution#Degenerate_case">
Degenerate case in Multivariate normal distribution (Wikipedia)</a>)
<p>
param: mu The mean vector of the distribution
param: sigma The covariance matrix of the distribution</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../serialized-form.html#org.apache.spark.mllib.stat.distribution.MultivariateGaussian">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/spark/mllib/stat/distribution/MultivariateGaussian.html#MultivariateGaussian(org.apache.spark.mllib.linalg.Vector,%20org.apache.spark.mllib.linalg.Matrix)">MultivariateGaussian</a></strong>(<a href="../../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> mu,
<a href="../../../../../../org/apache/spark/mllib/linalg/Matrix.html" title="interface in org.apache.spark.mllib.linalg">Matrix</a> sigma)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/spark/mllib/stat/distribution/MultivariateGaussian.html#logpdf(org.apache.spark.mllib.linalg.Vector)">logpdf</a></strong>(<a href="../../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> x)</code>
<div class="block">Returns the log-density of this multivariate Gaussian at given point, x</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/spark/mllib/stat/distribution/MultivariateGaussian.html#mu()">mu</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/spark/mllib/stat/distribution/MultivariateGaussian.html#pdf(org.apache.spark.mllib.linalg.Vector)">pdf</a></strong>(<a href="../../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> x)</code>
<div class="block">Returns density of this multivariate Gaussian at given point, x</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/spark/mllib/linalg/Matrix.html" title="interface in org.apache.spark.mllib.linalg">Matrix</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/spark/mllib/stat/distribution/MultivariateGaussian.html#sigma()">sigma</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_Object">
<!-- -->
</a>
<h3>Methods inherited from class Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MultivariateGaussian(org.apache.spark.mllib.linalg.Vector, org.apache.spark.mllib.linalg.Matrix)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MultivariateGaussian</h4>
<pre>public MultivariateGaussian(<a href="../../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> mu,
<a href="../../../../../../org/apache/spark/mllib/linalg/Matrix.html" title="interface in org.apache.spark.mllib.linalg">Matrix</a> sigma)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="mu()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mu</h4>
<pre>public <a href="../../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> mu()</pre>
</li>
</ul>
<a name="sigma()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sigma</h4>
<pre>public <a href="../../../../../../org/apache/spark/mllib/linalg/Matrix.html" title="interface in org.apache.spark.mllib.linalg">Matrix</a> sigma()</pre>
</li>
</ul>
<a name="pdf(org.apache.spark.mllib.linalg.Vector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pdf</h4>
<pre>public double pdf(<a href="../../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> x)</pre>
<div class="block">Returns density of this multivariate Gaussian at given point, x</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="logpdf(org.apache.spark.mllib.linalg.Vector)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>logpdf</h4>
<pre>public double logpdf(<a href="../../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> x)</pre>
<div class="block">Returns the log-density of this multivariate Gaussian at given point, x</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/spark/mllib/stat/distribution/MultivariateGaussian.html" target="_top">Frames</a></li>
<li><a href="MultivariateGaussian.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<script defer="defer" type="text/javascript" src="../../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../../lib/api-javadocs.js"></script></body>
</html>
|
<style>
.total-price-sum {
font-weight: bolder;
font-size: 16px;
}
</style>
<div class="row-content am-cf">
<div class="row">
<div class="am-u-sm-12 am-u-md-12 am-u-lg-12">
<div class="widget am-cf">
<div class="widget-head am-cf">
<div class="widget-title am-cf">全部订单列表</div>
</div>
<div class="widget-body am-fr">
<div class="page_toolbar am-margin-bottom-xs am-cf">
<form class="toolbar-form" id="my-form" method="post">
{if condition="$request->action() eq 'all_list'"}
<div class="am-u-sm-12 am-u-md-3">
<div class="am-form-group">
<div class="am-btn-group am-btn-group-xs">
<a class="j-export am-btn am-btn-default am-btn-success"
href="javascript:;">
<span class="am-icon-download"></span> 导出订单
</a>
</div>
</div>
</div>
{/if}
<div class="am-u-sm-12 am-u-md-9">
<div class="am fr">
{if condition="$request->action() eq 'all_list'"}
<div class="am-form-group am-fl">
<select name="status" data-am-selected="{btnSize: 'sm', placeholder: '订单状态'}">
<option value="">订单状态</option>
{volist name='statusList' id='vo'}
<option value="{$key}" {if $request->post('status') eq $key}selected{/if}>{$vo}
</option>
{/volist}
</select>
</div>
{/if}
<div class="am-form-group am-fl">
<select name="member_id"
data-am-selected="{btnSize: 'sm', searchBox:1,placeholder: '用户名称', maxHeight: 400}">
<option value=""></option>
{volist name='member' id='vo'}
<option value="{$vo.member_id}" {if $request->post('member_id') eq $vo.member_id}selected{/if}>{$vo.member_name}
</option>
{/volist}
</select>
</div>
<div class="am-form-group am-fl">
<div class="am-input-group am-input-group-sm tpl-form-border-form">
<input type="text" class="am-form-field" name="order_sn"
placeholder="请输入订单号"
value="{$request->post('order_sn')|raw}">
<div class="am-input-group-btn">
<button class="am-btn am-btn-default am-icon-search"
type="submit"></button>
</div>
</div>
</div>
</div>
</div>
</form>
</div>
<div class="am-scrollable-horizontal am-u-sm-12">
<form id="order-form" method="post" action="{:url('order/exportOrder')}">
<table width="100%" class="am-table am-table-compact am-table-striped
tpl-table-black am-text-nowrap">
<thead>
<tr>
<th><input type="checkbox" class="check_all"></th>
<th>订单号</th>
<th>下单人</th>
<th>总价(¥)</th>
<th>付款方式</th>
<th>订单时间</th>
<th>付款单号</th>
<th>订单状态</th>
<th>操作</th>
</tr>
</thead>
<tbody>
{volist name='list' id='vo'}
<tr>
<td class="am-text-middle">
<input type="checkbox" class="checkbox-item" name="order_id[]"
value="{$vo.order_id}" data-total-price="{$vo.total_price}">
</td>
<td class="am-text-middle">{$vo.order_sn}</td>
<td class="am-text-middle">{$vo.member_name}</td>
<td class="am-text-middle" style='color:#fc6d26'>{$vo.total_price}</td>
<td class="am-text-middle">
{$vo.payment_type_name}
</td>
<td class="am-text-middle">{$vo.create_time|date="Y-m-d H:i:s"}</td>
<td class="am-text-middle">{$vo.payment_sn}</td>
<td class="am-text-middle">{$statusList[$vo.status]}</td>
<td class="am-text-middle">
<div class="tpl-table-black-operation"> <a href="{:url('order/edit',['order_id'=>$vo.order_id])}">
<i class="am-icon-pencil"></i> 更新
</a>
<a href="javascript:void(0);"
class="item-delete tpl-table-black-operation-del"
data-id="{$vo.order_id}">
<i class="am-icon-trash"></i> 删除
</a>
</div>
</td>
</tr>
{/volist}
</tbody>
</table>
</form>
</div>
<div class="am-u-sm-12">
<a class="delOrder am-btn am-btn-success am-btn-xs" href="javascript:;">
删除
</a>
<a class="exportOrder am-btn am-btn-primary am-btn-xs" href="javascript:;">
导出订单
</a>
</div>
<div class="am-u-lg-12 am-cf text-center">
<div class="am-fl pagination-total am-margin-right">
<div class="am-vertical-align-middle">总计：￥<span class="total-price-sum">0</span></div>
</div>
<div class="am-fr">{$list->render()|raw}</div>
<div class="am-fr pagination-total am-margin-right">
<div class="am-vertical-align-middle">总记录：{$list->total()}</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script>
$(function () {
$('.check_all').on('click', function () {
let type = $(this).prop('checked');
$('.checkbox-item').prop('checked', type);
});
$('input[type=checkbox]').on('change', function () {
if (!$(this).prop('checked'))
$('.check_all').prop('checked', false);
let totalPrice = 0;
$('.checkbox-item:checked').each(function () {
totalPrice += parseInt($(this).data('totalPrice'));
})
$('.total-price-sum').html(totalPrice);
})
$('.item-delete').delete('order_id', "{:url('order/delete')}", '删除后不可恢复，确定要删除吗？');
$('.delOrder').on('click', function () {
if ($('.checkbox-item:checked').length < 1) {
$.show_error('请勾选删除的订单');
return false;
}
let that = $(this);
layer.confirm('确定删除所有选择的订单?', function (index) {
that.attr('disabled', true);
layer.close(index);
let load = layer.load();
$.ajax({
type: 'post',
url: "{:url('order/deleteAll')}",
data: $('#order-form').serialize(),
success: function (res) {
layer.close(load);
that.attr('disabled', false)
if (res.data.length != 0) {
let str = '';
for (let i = 0; i < res.data.length; i++) {
str += res.data[i]['order_sn'] + '--' + res.data[i]['error'] + '<br />';
}
layer.open({
type: 1,
area: ['420px', '240px'],
content: str,
cancel: function (index, layero) {
location.reload()
}
});
} else {
$.show_success(res.msg);
}
}
})
layer.close(index);
});
});
$('.j-export').click(function () {
let data = {}, formData = $('#my-form').serializeArray();
$.each(formData, function () {
this.name !== 's' && (data[this.name] = this.value);
});
window.location = "{:url('order/export')}?" + $.urlEncode(data);
})
$('.exportOrder').click(function () {
if ($('.checkbox-item:checked').length < 1) {
$.show_error('请勾选需要导出的订单');
return false;
}
$('#order-form').submit();
})
});
</script>
|
---
layout: home
title: Samputa
subtitle: Local community marketplace
---
|
<!DOCTYPE html>
<html lang="en" dir="rtl">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Limitless - Responsive Web Application Kit by Eugene Kopyov</title>
<!-- Global stylesheets -->
<link href="https://fonts.googleapis.com/css?family=Roboto:400,300,100,500,700,900" rel="stylesheet" type="text/css">
<link href="../../../../global_assets/css/icons/icomoon/styles.css" rel="stylesheet" type="text/css">
<link href="assets/css/bootstrap.min.css" rel="stylesheet" type="text/css">
<link href="assets/css/core.min.css" rel="stylesheet" type="text/css">
<link href="assets/css/components.min.css" rel="stylesheet" type="text/css">
<link href="assets/css/colors.min.css" rel="stylesheet" type="text/css">
<!-- /global stylesheets -->
<!-- Core JS files -->
<script src="../../../../global_assets/js/plugins/loaders/pace.min.js"></script>
<script src="../../../../global_assets/js/core/libraries/jquery.min.js"></script>
<script src="../../../../global_assets/js/core/libraries/bootstrap.min.js"></script>
<script src="../../../../global_assets/js/plugins/loaders/blockui.min.js"></script>
<!-- /core JS files -->
<!-- Theme JS files -->
<script src="../../../../global_assets/js/plugins/visualization/d3/d3.min.js"></script>
<script src="../../../../global_assets/js/plugins/visualization/d3/d3_tooltip.js"></script>
<script src="../../../../global_assets/js/plugins/forms/styling/switchery.min.js"></script>
<script src="../../../../global_assets/js/plugins/forms/selects/bootstrap_multiselect.js"></script>
<script src="../../../../global_assets/js/plugins/ui/moment/moment.min.js"></script>
<script src="../../../../global_assets/js/plugins/pickers/daterangepicker.js"></script>
<script src="assets/js/app.js"></script>
<script src="../../../../global_assets/js/demo_pages/dashboard.js"></script>
<script src="../../../../global_assets/js/demo_pages/layout_fixed_native.js"></script>
<script src="../../../../global_assets/js/plugins/ui/ripple.min.js"></script>
<!-- /theme JS files -->
</head>
<body class="navbar-top">
<!-- Main navbar -->
<div class="navbar navbar-default navbar-fixed-top header-highlight">
<div class="navbar-header">
<a class="navbar-brand" href="index.html"><img src="../../../../global_assets/images/logo_light.png" alt=""></a>
<ul class="nav navbar-nav visible-xs-block">
<li><a data-toggle="collapse" data-target="#navbar-mobile"><i class="icon-tree5"></i></a></li>
<li><a class="sidebar-mobile-main-toggle"><i class="icon-paragraph-justify3"></i></a></li>
</ul>
</div>
<div class="navbar-collapse collapse" id="navbar-mobile">
<ul class="nav navbar-nav">
<li><a class="sidebar-control sidebar-main-toggle hidden-xs"><i class="icon-paragraph-justify3"></i></a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
<i class="icon-puzzle3"></i>
<span class="visible-xs-inline-block position-right">Git updates</span>
<span class="status-mark border-pink-300"></span>
</a>
<div class="dropdown-menu dropdown-content">
<div class="dropdown-content-heading">
Git updates
<ul class="icons-list">
<li><a href="#"><i class="icon-sync"></i></a></li>
</ul>
</div>
<ul class="media-list dropdown-content-body width-350">
<li class="media">
<div class="media-left">
<a href="#" class="btn border-primary text-primary btn-flat btn-rounded btn-icon btn-sm"><i class="icon-git-pull-request"></i></a>
</div>
<div class="media-body">
Drop the IE <a href="#">specific hacks</a> for temporal inputs
<div class="media-annotation">4 minutes ago</div>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn border-warning text-warning btn-flat btn-rounded btn-icon btn-sm"><i class="icon-git-commit"></i></a>
</div>
<div class="media-body">
Add full font overrides for popovers and tooltips
<div class="media-annotation">36 minutes ago</div>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn border-info text-info btn-flat btn-rounded btn-icon btn-sm"><i class="icon-git-branch"></i></a>
</div>
<div class="media-body">
<a href="#">Chris Arney</a> created a new <span class="text-semibold">Design</span> branch
<div class="media-annotation">2 hours ago</div>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn border-success text-success btn-flat btn-rounded btn-icon btn-sm"><i class="icon-git-merge"></i></a>
</div>
<div class="media-body">
<a href="#">Eugene Kopyov</a> merged <span class="text-semibold">Master</span> and <span class="text-semibold">Dev</span> branches
<div class="media-annotation">Dec 18, 18:36</div>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn border-primary text-primary btn-flat btn-rounded btn-icon btn-sm"><i class="icon-git-pull-request"></i></a>
</div>
<div class="media-body">
Have Carousel ignore keyboard events
<div class="media-annotation">Dec 12, 05:46</div>
</div>
</li>
</ul>
<div class="dropdown-content-footer">
<a href="#" data-popup="tooltip" title="All activity"><i class="icon-menu display-block"></i></a>
</div>
</div>
</li>
</ul>
<div class="navbar-right">
<p class="navbar-text">Morning, Victoria!</p>
<p class="navbar-text"><span class="label bg-success">Online</span></p>
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
<i class="icon-bell2"></i>
<span class="visible-xs-inline-block position-right">Activity</span>
<span class="status-mark border-pink-300"></span>
</a>
<div class="dropdown-menu dropdown-content">
<div class="dropdown-content-heading">
Activity
<ul class="icons-list">
<li><a href="#"><i class="icon-menu7"></i></a></li>
</ul>
</div>
<ul class="media-list dropdown-content-body width-350">
<li class="media">
<div class="media-left">
<a href="#" class="btn bg-success-400 btn-rounded btn-icon btn-xs"><i class="icon-mention"></i></a>
</div>
<div class="media-body">
<a href="#">Taylor Swift</a> mentioned you in a post "Angular JS. Tips and tricks"
<div class="media-annotation">4 minutes ago</div>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn bg-pink-400 btn-rounded btn-icon btn-xs"><i class="icon-paperplane"></i></a>
</div>
<div class="media-body">
Special offers have been sent to subscribed users by <a href="#">Donna Gordon</a>
<div class="media-annotation">36 minutes ago</div>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn bg-blue btn-rounded btn-icon btn-xs"><i class="icon-plus3"></i></a>
</div>
<div class="media-body">
<a href="#">Chris Arney</a> created a new <span class="text-semibold">Design</span> branch in <span class="text-semibold">Limitless</span> repository
<div class="media-annotation">2 hours ago</div>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn bg-purple-300 btn-rounded btn-icon btn-xs"><i class="icon-truck"></i></a>
</div>
<div class="media-body">
Shipping cost to the Netherlands has been reduced, database updated
<div class="media-annotation">Feb 8, 11:30</div>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn bg-warning-400 btn-rounded btn-icon btn-xs"><i class="icon-bubble8"></i></a>
</div>
<div class="media-body">
New review received on <a href="#">Server side integration</a> services
<div class="media-annotation">Feb 2, 10:20</div>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn bg-teal-400 btn-rounded btn-icon btn-xs"><i class="icon-spinner11"></i></a>
</div>
<div class="media-body">
<strong>January, 2016</strong> - 1320 new users, 3284 orders, $49,390 revenue
<div class="media-annotation">Feb 1, 05:46</div>
</div>
</li>
</ul>
</div>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
<i class="icon-bubble8"></i>
<span class="visible-xs-inline-block position-right">Messages</span>
<span class="status-mark border-pink-300"></span>
</a>
<div class="dropdown-menu dropdown-content width-350">
<div class="dropdown-content-heading">
Messages
<ul class="icons-list">
<li><a href="#"><i class="icon-compose"></i></a></li>
</ul>
</div>
<ul class="media-list dropdown-content-body">
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt="">
<span class="badge bg-danger-400 media-badge">5</span>
</div>
<div class="media-body">
<a href="#" class="media-heading">
<span class="text-semibold">James Alexander</span>
<span class="media-annotation pull-right">04:58</span>
</a>
<span class="text-muted">who knows, maybe that would be the best thing for me...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt="">
<span class="badge bg-danger-400 media-badge">4</span>
</div>
<div class="media-body">
<a href="#" class="media-heading">
<span class="text-semibold">Margo Baker</span>
<span class="media-annotation pull-right">12:16</span>
</a>
<span class="text-muted">That was something he was unable to do because...</span>
</div>
</li>
<li class="media">
<div class="media-left"><img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt=""></div>
<div class="media-body">
<a href="#" class="media-heading">
<span class="text-semibold">Jeremy Victorino</span>
<span class="media-annotation pull-right">22:48</span>
</a>
<span class="text-muted">But that would be extremely strained and suspicious...</span>
</div>
</li>
<li class="media">
<div class="media-left"><img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt=""></div>
<div class="media-body">
<a href="#" class="media-heading">
<span class="text-semibold">Beatrix Diaz</span>
<span class="media-annotation pull-right">Tue</span>
</a>
<span class="text-muted">What a strenuous career it is that I've chosen...</span>
</div>
</li>
<li class="media">
<div class="media-left"><img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt=""></div>
<div class="media-body">
<a href="#" class="media-heading">
<span class="text-semibold">Richard Vango</span>
<span class="media-annotation pull-right">Mon</span>
</a>
<span class="text-muted">Other travelling salesmen live a life of luxury...</span>
</div>
</li>
</ul>
<div class="dropdown-content-footer">
<a href="#" data-popup="tooltip" title="All messages"><i class="icon-menu display-block"></i></a>
</div>
</div>
</li>
</ul>
</div>
</div>
</div>
<!-- /main navbar -->
<!-- Page container -->
<div class="page-container">
<!-- Page content -->
<div class="page-content">
<!-- Main sidebar -->
<div class="sidebar sidebar-main sidebar-fixed">
<div class="sidebar-content">
<!-- User menu -->
<div class="sidebar-user-material">
<div class="category-content">
<div class="sidebar-user-material-content">
<a href="#"><img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-responsive" alt=""></a>
<h6>Victoria Baker</h6>
<span class="text-size-small">Santa Ana, CA</span>
</div>
<div class="sidebar-user-material-menu">
<a href="#user-nav" data-toggle="collapse"><span>My account</span> <i class="caret"></i></a>
</div>
</div>
<div class="navigation-wrapper collapse" id="user-nav">
<ul class="navigation">
<li><a href="#"><i class="icon-user-plus"></i> <span>My profile</span></a></li>
<li><a href="#"><i class="icon-coins"></i> <span>My balance</span></a></li>
<li><a href="#"><i class="icon-comment-discussion"></i> <span><span class="badge bg-teal-400 pull-right">58</span> Messages</span></a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-cog5"></i> <span>Account settings</span></a></li>
<li><a href="#"><i class="icon-switch2"></i> <span>Logout</span></a></li>
</ul>
</div>
</div>
<!-- /user menu -->
<!-- Main navigation -->
<div class="sidebar-category sidebar-category-visible">
<div class="category-content no-padding">
<ul class="navigation navigation-main navigation-accordion">
<!-- Main -->
<li class="navigation-header"><span>Main</span> <i class="icon-menu" title="Main pages"></i></li>
<li><a href="index.html"><i class="icon-home4"></i> <span>Dashboard</span></a></li>
<li>
<a href="#"><i class="icon-stack2"></i> <span>Page layouts</span></a>
<ul>
<li><a href="layout_navbar_fixed.html">Fixed navbar</a></li>
<li><a href="layout_navbar_sidebar_fixed.html">Fixed navbar & sidebar</a></li>
<li class="active"><a href="layout_sidebar_fixed_native.html">Fixed sidebar native scroll</a></li>
<li><a href="layout_navbar_hideable.html">Hideable navbar</a></li>
<li><a href="layout_navbar_hideable_sidebar.html">Hideable & fixed sidebar</a></li>
<li><a href="layout_footer_fixed.html">Fixed footer</a></li>
<li class="navigation-divider"></li>
<li><a href="boxed_default.html">Boxed with default sidebar</a></li>
<li><a href="boxed_mini.html">Boxed with mini sidebar</a></li>
<li><a href="boxed_full.html">Boxed full width</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-copy"></i> <span>Layouts</span></a>
<ul>
<li><a href="../../../../layout_1/LTR/default/index.html" id="layout1">Layout 1</a></li>
<li><a href="index.html" id="layout2">Layout 2 <span class="label bg-warning-400">Current</span></a></li>
<li><a href="../../../../layout_3/LTR/default/index.html" id="layout3">Layout 3</a></li>
<li><a href="../../../../layout_4/LTR/default/index.html" id="layout4">Layout 4</a></li>
<li><a href="../../../../layout_5/LTR/default/index.html" id="layout5">Layout 5</a></li>
<li class="disabled"><a href="../../../../layout_6/LTR/default/index.html" id="layout6">Layout 6 <span class="label label-transparent">Coming soon</span></a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-droplet2"></i> <span>Color system</span></a>
<ul>
<li><a href="colors_primary.html">Primary palette</a></li>
<li><a href="colors_danger.html">Danger palette</a></li>
<li><a href="colors_success.html">Success palette</a></li>
<li><a href="colors_warning.html">Warning palette</a></li>
<li><a href="colors_info.html">Info palette</a></li>
<li class="navigation-divider"></li>
<li><a href="colors_pink.html">Pink palette</a></li>
<li><a href="colors_violet.html">Violet palette</a></li>
<li><a href="colors_purple.html">Purple palette</a></li>
<li><a href="colors_indigo.html">Indigo palette</a></li>
<li><a href="colors_blue.html">Blue palette</a></li>
<li><a href="colors_teal.html">Teal palette</a></li>
<li><a href="colors_green.html">Green palette</a></li>
<li><a href="colors_orange.html">Orange palette</a></li>
<li><a href="colors_brown.html">Brown palette</a></li>
<li><a href="colors_grey.html">Grey palette</a></li>
<li><a href="colors_slate.html">Slate palette</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-stack"></i> <span>Starter kit</span></a>
<ul>
<li><a href="../seed/horizontal_nav.html">Horizontal navigation</a></li>
<li><a href="../seed/1_col.html">1 column</a></li>
<li><a href="../seed/2_col.html">2 columns</a></li>
<li>
<a href="#">3 columns</a>
<ul>
<li><a href="../seed/3_col_dual.html">Dual sidebars</a></li>
<li><a href="../seed/3_col_double.html">Double sidebars</a></li>
</ul>
</li>
<li><a href="../seed/4_col.html">4 columns</a></li>
<li>
<a href="#">Detached layout</a>
<ul>
<li><a href="../seed/detached_left.html">Left sidebar</a></li>
<li><a href="../seed/detached_right.html">Right sidebar</a></li>
<li><a href="../seed/detached_sticky.html">Sticky sidebar</a></li>
</ul>
</li>
<li><a href="../seed/layout_boxed.html">Boxed layout</a></li>
<li class="navigation-divider"></li>
<li><a href="../seed/layout_navbar_fixed_main.html">Fixed main navbar</a></li>
<li><a href="../seed/layout_navbar_fixed_secondary.html">Fixed secondary navbar</a></li>
<li><a href="../seed/layout_navbar_fixed_both.html">Both navbars fixed</a></li>
<li><a href="../seed/layout_fixed.html">Fixed layout</a></li>
</ul>
</li>
<li><a href="changelog.html"><i class="icon-list-unordered"></i> <span>Changelog <span class="label bg-blue-400">2.0</span></span></a></li>
<li><a href="../../../RTL/default/full/index.html"><i class="icon-width"></i> <span>RTL version</span></a></li>
<!-- /main -->
<!-- Forms -->
<li class="navigation-header"><span>Forms</span> <i class="icon-menu" title="Forms"></i></li>
<li>
<a href="#"><i class="icon-pencil3"></i> <span>Form components</span></a>
<ul>
<li><a href="form_inputs_basic.html">Basic inputs</a></li>
<li><a href="form_checkboxes_radios.html">Checkboxes & radios</a></li>
<li><a href="form_input_groups.html">Input groups</a></li>
<li><a href="form_controls_extended.html">Extended controls</a></li>
<li><a href="form_floating_labels.html">Floating labels</a></li>
<li>
<a href="#">Selects</a>
<ul>
<li><a href="form_select2.html">Select2 selects</a></li>
<li><a href="form_multiselect.html">Bootstrap multiselect</a></li>
<li><a href="form_select_box_it.html">SelectBoxIt selects</a></li>
<li><a href="form_bootstrap_select.html">Bootstrap selects</a></li>
</ul>
</li>
<li><a href="form_tag_inputs.html">Tag inputs</a></li>
<li><a href="form_dual_listboxes.html">Dual Listboxes</a></li>
<li><a href="form_validation.html">Validation</a></li>
<li><a href="form_inputs_grid.html">Inputs grid</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-file-css"></i> <span>JSON forms</span></a>
<ul>
<li><a href="alpaca_basic.html">Basic inputs</a></li>
<li><a href="alpaca_advanced.html">Advanced inputs</a></li>
<li><a href="alpaca_controls.html">Controls</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-footprint"></i> <span>Wizards</span></a>
<ul>
<li><a href="wizard_steps.html">Steps wizard</a></li>
<li><a href="wizard_form.html">Form wizard</a></li>
<li><a href="wizard_stepy.html">Stepy wizard</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-spell-check"></i> <span>Editors</span></a>
<ul>
<li><a href="editor_summernote.html">Summernote editor</a></li>
<li><a href="editor_ckeditor.html">CKEditor</a></li>
<li><a href="editor_wysihtml5.html">WYSIHTML5 editor</a></li>
<li><a href="editor_code.html">Code editor</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-select2"></i> <span>Pickers</span></a>
<ul>
<li><a href="picker_date.html">Date & time pickers</a></li>
<li><a href="picker_color.html">Color pickers</a></li>
<li><a href="picker_location.html">Location pickers</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-insert-template"></i> <span>Form layouts</span></a>
<ul>
<li><a href="form_layout_vertical.html">Vertical form</a></li>
<li><a href="form_layout_horizontal.html">Horizontal form</a></li>
</ul>
</li>
<!-- /forms -->
<!-- Appearance -->
<li class="navigation-header"><span>Appearance</span> <i class="icon-menu" title="Appearance"></i></li>
<li>
<a href="#"><i class="icon-grid"></i> <span>Components</span></a>
<ul>
<li><a href="components_modals.html">Modals</a></li>
<li><a href="components_dropdowns.html">Dropdown menus</a></li>
<li><a href="components_tabs.html">Tabs component</a></li>
<li><a href="components_pills.html">Pills component</a></li>
<li><a href="components_navs.html">Accordion and navs</a></li>
<li><a href="components_buttons.html">Buttons</a></li>
<li><a href="components_notifications_pnotify.html">PNotify notifications</a></li>
<li><a href="components_notifications_others.html">Other notifications</a></li>
<li><a href="components_popups.html">Tooltips and popovers</a></li>
<li><a href="components_alerts.html">Alerts</a></li>
<li><a href="components_pagination.html">Pagination</a></li>
<li><a href="components_labels.html">Labels and badges</a></li>
<li><a href="components_loaders.html">Loaders and bars</a></li>
<li><a href="components_thumbnails.html">Thumbnails</a></li>
<li><a href="components_page_header.html">Page header</a></li>
<li><a href="components_breadcrumbs.html">Breadcrumbs</a></li>
<li><a href="components_media.html">Media objects</a></li>
<li><a href="components_affix.html">Affix and Scrollspy</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-puzzle2"></i> <span>Content appearance</span></a>
<ul>
<li><a href="appearance_content_panels.html">Content panels</a></li>
<li><a href="appearance_panel_heading.html">Panel heading elements</a></li>
<li><a href="appearance_panel_footer.html">Panel footer elements</a></li>
<li><a href="appearance_draggable_panels.html">Draggable panels</a></li>
<li><a href="appearance_text_styling.html">Text styling</a></li>
<li><a href="appearance_typography.html">Typography</a></li>
<li><a href="appearance_helpers.html">Helper classes</a></li>
<li><a href="appearance_syntax_highlighter.html">Syntax highlighter</a></li>
<li><a href="appearance_content_grid.html">Grid system</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-gift"></i> <span>Extra components</span></a>
<ul>
<li><a href="extra_sliders_noui.html">NoUI sliders</a></li>
<li><a href="extra_sliders_ion.html">Ion range sliders</a></li>
<li><a href="extra_session_timeout.html">Session timeout</a></li>
<li><a href="extra_idle_timeout.html">Idle timeout</a></li>
<li><a href="extra_trees.html">Dynamic tree views</a></li>
<li><a href="extra_context_menu.html">Context menu</a></li>
<li><a href="extra_fab.html">Floating action buttons</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-spinner2 spinner"></i> <span>Animations</span></a>
<ul>
<li><a href="animations_css3.html">CSS3 animations</a></li>
<li>
<a href="#">Velocity animations</a>
<ul>
<li><a href="animations_velocity_basic.html">Basic usage</a></li>
<li><a href="animations_velocity_ui.html">UI pack effects</a></li>
<li><a href="animations_velocity_examples.html">Advanced examples</a></li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#"><i class="icon-thumbs-up2"></i> <span>Icons</span></a>
<ul>
<li><a href="icons_glyphicons.html">Glyphicons</a></li>
<li><a href="icons_icomoon.html">Icomoon</a></li>
<li><a href="icons_fontawesome.html">Font awesome</a></li>
</ul>
</li>
<!-- /appearance -->
<!-- Layout -->
<li class="navigation-header"><span>Layout</span> <i class="icon-menu" title="Layout options"></i></li>
<li>
<a href="#"><i class="icon-indent-decrease2"></i> <span>Sidebars</span></a>
<ul>
<li><a href="sidebar_default_collapse.html">Default collapsible</a></li>
<li><a href="sidebar_default_hide.html">Default hideable</a></li>
<li><a href="sidebar_mini_collapse.html">Mini collapsible</a></li>
<li><a href="sidebar_mini_hide.html">Mini hideable</a></li>
<li>
<a href="#">Dual sidebar</a>
<ul>
<li><a href="sidebar_dual.html">Dual sidebar</a></li>
<li><a href="sidebar_dual_double_collapse.html">Dual double collapse</a></li>
<li><a href="sidebar_dual_double_hide.html">Dual double hide</a></li>
<li><a href="sidebar_dual_swap.html">Swap sidebars</a></li>
</ul>
</li>
<li>
<a href="#">Double sidebar</a>
<ul>
<li><a href="sidebar_double_collapse.html">Collapse main sidebar</a></li>
<li><a href="sidebar_double_hide.html">Hide main sidebar</a></li>
<li><a href="sidebar_double_fix_default.html">Fix default width</a></li>
<li><a href="sidebar_double_fix_mini.html">Fix mini width</a></li>
<li><a href="sidebar_double_visible.html">Opposite sidebar visible</a></li>
</ul>
</li>
<li>
<a href="#">Detached sidebar</a>
<ul>
<li><a href="sidebar_detached_left.html">Left position</a></li>
<li><a href="sidebar_detached_right.html">Right position</a></li>
<li><a href="sidebar_detached_sticky_custom.html">Sticky (custom scroll)</a></li>
<li><a href="sidebar_detached_sticky_native.html">Sticky (native scroll)</a></li>
<li><a href="sidebar_detached_separate.html">Separate categories</a></li>
</ul>
</li>
<li><a href="sidebar_hidden.html">Hidden sidebar</a></li>
<li><a href="sidebar_light.html">Light sidebar</a></li>
<li><a href="sidebar_components.html">Sidebar components</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-sort"></i> <span>Vertical navigation</span></a>
<ul>
<li><a href="navigation_vertical_collapsible.html">Collapsible menu</a></li>
<li><a href="navigation_vertical_accordion.html">Accordion menu</a></li>
<li><a href="navigation_vertical_sizing.html">Navigation sizing</a></li>
<li><a href="navigation_vertical_bordered.html">Bordered navigation</a></li>
<li><a href="navigation_vertical_right_icons.html">Right icons</a></li>
<li><a href="navigation_vertical_labels_badges.html">Labels and badges</a></li>
<li><a href="navigation_vertical_disabled.html">Disabled navigation links</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-transmission"></i> <span>Horizontal navigation</span></a>
<ul>
<li><a href="navigation_horizontal_click.html">Submenu on click</a></li>
<li><a href="navigation_horizontal_hover.html">Submenu on hover</a></li>
<li><a href="navigation_horizontal_elements.html">With custom elements</a></li>
<li><a href="navigation_horizontal_tabs.html">Tabbed navigation</a></li>
<li><a href="navigation_horizontal_disabled.html">Disabled navigation links</a></li>
<li><a href="navigation_horizontal_mega.html">Horizontal mega menu</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-menu3"></i> <span>Navbars</span></a>
<ul>
<li><a href="navbar_single.html">Single navbar</a></li>
<li>
<a href="#">Multiple navbars</a>
<ul>
<li><a href="navbar_multiple_navbar_navbar.html">Navbar + navbar</a></li>
<li><a href="navbar_multiple_navbar_header.html">Navbar + header</a></li>
<li><a href="navbar_multiple_header_navbar.html">Header + navbar</a></li>
<li><a href="navbar_multiple_top_bottom.html">Top + bottom</a></li>
</ul>
</li>
<li><a href="navbar_colors.html">Color options</a></li>
<li><a href="navbar_sizes.html">Sizing options</a></li>
<li><a href="navbar_hideable.html">Hide on scroll</a></li>
<li><a href="navbar_components.html">Navbar components</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-tree5"></i> <span>Menu levels</span></a>
<ul>
<li><a href="#"><i class="icon-IE"></i> Second level</a></li>
<li>
<a href="#"><i class="icon-firefox"></i> Second level with child</a>
<ul>
<li><a href="#"><i class="icon-android"></i> Third level</a></li>
<li>
<a href="#"><i class="icon-apple2"></i> Third level with child</a>
<ul>
<li><a href="#"><i class="icon-html5"></i> Fourth level</a></li>
<li><a href="#"><i class="icon-css3"></i> Fourth level</a></li>
</ul>
</li>
<li><a href="#"><i class="icon-windows"></i> Third level</a></li>
</ul>
</li>
<li><a href="#"><i class="icon-chrome"></i> Second level</a></li>
</ul>
</li>
<!-- /layout -->
<!-- Data visualization -->
<li class="navigation-header"><span>Data visualization</span> <i class="icon-menu" title="Data visualization"></i></li>
<li>
<a href="#"><i class="icon-graph"></i> <span>Echarts library</span></a>
<ul>
<li><a href="echarts_lines.html">Line charts</a></li>
<li><a href="echarts_areas.html">Area charts</a></li>
<li><a href="echarts_columns_waterfalls.html">Columns and waterfalls</a></li>
<li><a href="echarts_bars_tornados.html">Bars and tornados</a></li>
<li><a href="echarts_scatter.html">Scatter charts</a></li>
<li><a href="echarts_pies_donuts.html">Pies and donuts</a></li>
<li><a href="echarts_funnels_calendars.html">Funnels and calendars</a></li>
<li><a href="echarts_candlesticks_others.html">Candlesticks and others</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-statistics"></i> <span>D3 library</span></a>
<ul>
<li><a href="d3_lines_basic.html">Simple lines</a></li>
<li><a href="d3_lines_advanced.html">Advanced lines</a></li>
<li><a href="d3_bars_basic.html">Simple bars</a></li>
<li><a href="d3_bars_advanced.html">Advanced bars</a></li>
<li><a href="d3_pies.html">Pie charts</a></li>
<li><a href="d3_circle_diagrams.html">Circle diagrams</a></li>
<li><a href="d3_tree.html">Tree layout</a></li>
<li><a href="d3_other.html">Other charts</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-stats-dots"></i> <span>Dimple library</span></a>
<ul>
<li>
<a href="#">Line charts</a>
<ul>
<li><a href="dimple_lines_horizontal.html">Horizontal orientation</a></li>
<li><a href="dimple_lines_vertical.html">Vertical orientation</a></li>
</ul>
</li>
<li>
<a href="#">Bar charts</a>
<ul>
<li><a href="dimple_bars_horizontal.html">Horizontal orientation</a></li>
<li><a href="dimple_bars_vertical.html">Vertical orientation</a></li>
</ul>
</li>
<li>
<a href="#">Area charts</a>
<ul>
<li><a href="dimple_area_horizontal.html">Horizontal orientation</a></li>
<li><a href="dimple_area_vertical.html">Vertical orientation</a></li>
</ul>
</li>
<li>
<a href="#">Step charts</a>
<ul>
<li><a href="dimple_step_horizontal.html">Horizontal orientation</a></li>
<li><a href="dimple_step_vertical.html">Vertical orientation</a></li>
</ul>
</li>
<li><a href="dimple_pies.html">Pie charts</a></li>
<li><a href="dimple_rings.html">Ring charts</a></li>
<li><a href="dimple_scatter.html">Scatter charts</a></li>
<li><a href="dimple_bubble.html">Bubble charts</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-stats-bars"></i> <span>C3 library</span></a>
<ul>
<li><a href="c3_lines_areas.html">Lines and areas</a></li>
<li><a href="c3_bars_pies.html">Bars and pies</a></li>
<li><a href="c3_advanced.html">Advanced examples</a></li>
<li><a href="c3_axis.html">Chart axis</a></li>
<li><a href="c3_grid.html">Grid options</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-google"></i> <span>Google visualization</span></a>
<ul>
<li><a href="google_lines.html">Line charts</a></li>
<li><a href="google_bars.html">Bar charts</a></li>
<li><a href="google_pies.html">Pie charts</a></li>
<li><a href="google_scatter_bubble.html">Bubble & scatter charts</a></li>
<li><a href="google_other.html">Other charts</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-map5"></i> <span>Maps integration</span></a>
<ul>
<li>
<a href="#">Google maps</a>
<ul>
<li><a href="maps_google_basic.html">Basics</a></li>
<li><a href="maps_google_controls.html">Controls</a></li>
<li><a href="maps_google_markers.html">Markers</a></li>
<li><a href="maps_google_drawings.html">Map drawings</a></li>
<li><a href="maps_google_layers.html">Layers</a></li>
</ul>
</li>
<li><a href="maps_vector.html">Vector maps</a></li>
</ul>
</li>
<!-- /data visualization -->
<!-- Extensions -->
<li class="navigation-header"><span>Extensions</span> <i class="icon-menu" title="Extensions"></i></li>
<li>
<a href="#"><i class="icon-puzzle4"></i> <span>Extensions</span></a>
<ul>
<li><a href="extension_image_cropper.html">Image cropper</a></li>
<li><a href="extension_blockui.html">Block UI</a></li>
<li><a href="extension_dnd.html">Drag and drop</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-popout"></i> <span>JQuery UI</span></a>
<ul>
<li><a href="jqueryui_interactions.html">Interactions</a></li>
<li><a href="jqueryui_forms.html">Forms</a></li>
<li><a href="jqueryui_components.html">Components</a></li>
<li><a href="jqueryui_sliders.html">Sliders</a></li>
<li><a href="jqueryui_navigation.html">Navigation</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-upload"></i> <span>File uploaders</span></a>
<ul>
<li><a href="uploader_plupload.html">Plupload</a></li>
<li><a href="uploader_bootstrap.html">Bootstrap file uploader</a></li>
<li><a href="uploader_dropzone.html">Dropzone</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-calendar3"></i> <span>Event calendars</span></a>
<ul>
<li><a href="extension_fullcalendar_views.html">Basic views</a></li>
<li><a href="extension_fullcalendar_styling.html">Event styling</a></li>
<li><a href="extension_fullcalendar_formats.html">Language and time</a></li>
<li><a href="extension_fullcalendar_advanced.html">Advanced usage</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-sphere"></i> <span>Internationalization</span></a>
<ul>
<li><a href="internationalization_switch_direct.html">Direct translation</a></li>
<li><a href="internationalization_switch_query.html">Querystring parameter</a></li>
<li><a href="internationalization_fallback.html">Language fallback</a></li>
<li><a href="internationalization_callbacks.html">Callbacks</a></li>
</ul>
</li>
<!-- /extensions -->
<!-- Tables -->
<li class="navigation-header"><span>Tables</span> <i class="icon-menu" title="Tables"></i></li>
<li>
<a href="#"><i class="icon-table2"></i> <span>Basic tables</span></a>
<ul>
<li><a href="table_basic.html">Basic examples</a></li>
<li><a href="table_sizing.html">Table sizing</a></li>
<li><a href="table_borders.html">Table borders</a></li>
<li><a href="table_styling.html">Table styling</a></li>
<li><a href="table_elements.html">Table elements</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-grid7"></i> <span>Data tables</span></a>
<ul>
<li><a href="datatable_basic.html">Basic initialization</a></li>
<li><a href="datatable_styling.html">Basic styling</a></li>
<li><a href="datatable_advanced.html">Advanced examples</a></li>
<li><a href="datatable_sorting.html">Sorting options</a></li>
<li><a href="datatable_api.html">Using API</a></li>
<li><a href="datatable_data_sources.html">Data sources</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-alignment-unalign"></i> <span>Data tables extensions</span></a>
<ul>
<li><a href="datatable_extension_reorder.html">Columns reorder</a></li>
<li><a href="datatable_extension_row_reorder.html">Row reorder</a></li>
<li><a href="datatable_extension_fixed_columns.html">Fixed columns</a></li>
<li><a href="datatable_extension_fixed_header.html">Fixed header</a></li>
<li><a href="datatable_extension_autofill.html">Auto fill</a></li>
<li><a href="datatable_extension_key_table.html">Key table</a></li>
<li><a href="datatable_extension_scroller.html">Scroller</a></li>
<li><a href="datatable_extension_select.html">Select</a></li>
<li>
<a href="#">Buttons</a>
<ul>
<li><a href="datatable_extension_buttons_init.html">Initialization</a></li>
<li><a href="datatable_extension_buttons_flash.html">Flash buttons</a></li>
<li><a href="datatable_extension_buttons_print.html">Print buttons</a></li>
<li><a href="datatable_extension_buttons_html5.html">HTML5 buttons</a></li>
</ul>
</li>
<li><a href="datatable_extension_colvis.html">Columns visibility</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-file-spreadsheet"></i> <span>Handsontable</span></a>
<ul>
<li><a href="handsontable_basic.html">Basic configuration</a></li>
<li><a href="handsontable_advanced.html">Advanced setup</a></li>
<li><a href="handsontable_cols.html">Column features</a></li>
<li><a href="handsontable_cells.html">Cell features</a></li>
<li><a href="handsontable_types.html">Basic cell types</a></li>
<li><a href="handsontable_custom_checks.html">Custom & checkboxes</a></li>
<li><a href="handsontable_ac_password.html">Autocomplete & password</a></li>
<li><a href="handsontable_search.html">Search</a></li>
<li><a href="handsontable_context.html">Context menu</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-versions"></i> <span>Responsive options</span></a>
<ul>
<li><a href="table_responsive.html">Responsive basic tables</a></li>
<li><a href="datatable_responsive.html">Responsive data tables</a></li>
</ul>
</li>
<!-- /tables -->
<!-- Page kits -->
<li class="navigation-header"><span>Page kits</span> <i class="icon-menu" title="Page kits"></i></li>
<li>
<a href="#"><i class="icon-grid6"></i> <span>General pages</span></a>
<ul>
<li><a href="general_feed.html">Feed</a></li>
<li><a href="general_widgets_content.html">Content widgets</a></li>
<li><a href="general_widgets_stats.html">Statistics widgets</a></li>
<li><a href="general_embeds.html">Embeds</a></li>
<li><a href="general_faq.html">FAQ page</a></li>
<li><a href="general_knowledgebase.html">Knowledgebase</a></li>
<li>
<a href="#">Blog</a>
<ul>
<li><a href="blog_classic_v.html">Classic vertical</a></li>
<li><a href="blog_classic_h.html">Classic horizontal</a></li>
<li><a href="blog_grid.html">Grid</a></li>
<li><a href="blog_single.html">Single post</a></li>
<li class="navigation-divider"></li>
<li><a href="blog_sidebar_left.html">Left sidebar</a></li>
<li><a href="blog_sidebar_right.html">Right sidebar</a></li>
</ul>
</li>
<li>
<a href="#">Timelines</a>
<ul>
<li><a href="timelines_left.html">Left timeline</a></li>
<li><a href="timelines_right.html">Right timeline</a></li>
<li><a href="timelines_center.html">Centered timeline</a></li>
</ul>
</li>
<li>
<a href="#">Gallery</a>
<ul>
<li><a href="gallery_grid.html">Media grid</a></li>
<li><a href="gallery_titles.html">Media with titles</a></li>
<li><a href="gallery_description.html">Media with description</a></li>
<li><a href="gallery_library.html">Media library</a></li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#"><i class="icon-wrench3"></i> <span>Service pages</span></a>
<ul>
<li><a href="service_sitemap.html">Sitemap</a></li>
<li>
<a href="#">Invoicing</a>
<ul>
<li><a href="invoice_template.html">Invoice template</a></li>
<li><a href="invoice_grid.html">Invoice grid</a></li>
<li><a href="invoice_archive.html">Invoice archive</a></li>
</ul>
</li>
<li>
<a href="#">Authentication</a>
<ul>
<li><a href="login_simple.html">Simple login</a></li>
<li><a href="login_advanced.html">More login info</a></li>
<li><a href="login_registration.html">Simple registration</a></li>
<li><a href="login_registration_advanced.html">More registration info</a></li>
<li><a href="login_unlock.html">Unlock user</a></li>
<li><a href="login_password_recover.html">Reset password</a></li>
<li><a href="login_hide_navbar.html">Hide navbar</a></li>
<li><a href="login_transparent.html">Transparent box</a></li>
<li><a href="login_background.html">Background option</a></li>
<li><a href="login_validation.html">With validation</a></li>
<li><a href="login_tabbed.html">Tabbed form</a></li>
<li><a href="login_modals.html">Inside modals</a></li>
</ul>
</li>
<li>
<a href="#">Error pages</a>
<ul>
<li><a href="error_403.html">Error 403</a></li>
<li><a href="error_404.html">Error 404</a></li>
<li><a href="error_405.html">Error 405</a></li>
<li><a href="error_500.html">Error 500</a></li>
<li><a href="error_503.html">Error 503</a></li>
<li><a href="error_offline.html">Offline page</a></li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#"><i class="icon-people"></i> <span>User pages</span></a>
<ul>
<li><a href="user_pages_list.html">User list</a></li>
<li><a href="user_pages_cards.html">User cards</a></li>
<li><a href="user_pages_profile.html">Simple profile</a></li>
<li><a href="user_pages_profile_tabbed.html">Tabbed profile</a></li>
<li><a href="user_pages_profile_cover.html">Profile with cover</a></li>
</ul>
</li>
<li>
<a href="#"><i class="icon-cube3"></i> <span>Application pages</span></a>
<ul>
<li>
<a href="#">Task manager</a>
<ul>
<li><a href="task_manager_grid.html">Task grid</a></li>
<li><a href="task_manager_list.html">Task list</a></li>
<li><a href="task_manager_detailed.html">Task detailed</a></li>
</ul>
</li>
<li>
<a href="#">Inbox</a>
<ul>
<li><a href="mail_list.html">Mail list</a></li>
<li><a href="mail_list_detached.html">Mail list (detached)</a></li>
<li><a href="mail_read.html">Read mail</a></li>
<li><a href="mail_write.html">Write mail</a></li>
<li class="navigation-divider"></li>
<li><a href="chat_layouts.html">Chat layouts</a></li>
<li><a href="chat_options.html">Chat options</a></li>
</ul>
</li>
<li>
<a href="#">Search</a>
<ul>
<li><a href="search_basic.html">Basic search results</a></li>
<li><a href="search_users.html">User search results</a></li>
<li><a href="search_images.html">Image search results</a></li>
<li><a href="search_videos.html">Video search results</a></li>
</ul>
</li>
<li>
<a href="#">Job search</a>
<ul>
<li><a href="job_list_cards.html">Cards view</a></li>
<li><a href="job_list_panel.html">Panel view</a></li>
<li><a href="job_detailed.html">Job detailed</a></li>
<li><a href="job_apply.html">Apply</a></li>
</ul>
</li>
<li>
<a href="#">Learning</a>
<ul>
<li><a href="learning_list.html">List view</a></li>
<li><a href="learning_grid.html">Grid view</a></li>
<li><a href="learning_detailed.html">Detailed course</a></li>
</ul>
</li>
<li>
<a href="#">Ecommerce set</a>
<ul>
<li><a href="ecommerce_product_list.html">Product list</a></li>
<li><a href="ecommerce_product_grid.html">Product grid</a></li>
<li><a href="ecommerce_orders_history.html">Orders history</a></li>
<li><a href="ecommerce_customers.html">Customers</a></li>
<li><a href="ecommerce_pricing.html">Pricing tables</a></li>
</ul>
</li>
</ul>
</li>
<!-- /page kits -->
</ul>
</div>
</div>
<!-- /main navigation -->
</div>
</div>
<!-- /main sidebar -->
<!-- Main content -->
<div class="content-wrapper">
<!-- Content area -->
<div class="content">
<!-- Main charts -->
<div class="row">
<div class="col-lg-7">
<!-- Traffic sources -->
<div class="panel panel-flat">
<div class="panel-heading">
<h6 class="panel-title">Traffic sources</h6>
<div class="heading-elements">
<form class="heading-form" action="#">
<div class="form-group">
<label class="checkbox-inline checkbox-switchery checkbox-right switchery-xs">
<input type="checkbox" class="switch" checked="checked">
Live update:
</label>
</div>
</form>
</div>
</div>
<div class="container-fluid">
<div class="row">
<div class="col-lg-4">
<ul class="list-inline text-center">
<li>
<a href="#" class="btn border-teal text-teal btn-flat btn-rounded btn-icon btn-xs valign-text-bottom"><i class="icon-plus3"></i></a>
</li>
<li class="text-left">
<div class="text-semibold">New visitors</div>
<div class="text-muted">2,349 avg</div>
</li>
</ul>
<div class="col-lg-10 col-lg-offset-1">
<div class="chart content-group" id="new-visitors"></div>
</div>
</div>
<div class="col-lg-4">
<ul class="list-inline text-center">
<li>
<a href="#" class="btn border-warning-400 text-warning-400 btn-flat btn-rounded btn-icon btn-xs valign-text-bottom"><i class="icon-watch2"></i></a>
</li>
<li class="text-left">
<div class="text-semibold">New sessions</div>
<div class="text-muted">08:20 avg</div>
</li>
</ul>
<div class="col-lg-10 col-lg-offset-1">
<div class="chart content-group" id="new-sessions"></div>
</div>
</div>
<div class="col-lg-4">
<ul class="list-inline text-center">
<li>
<a href="#" class="btn border-indigo-400 text-indigo-400 btn-flat btn-rounded btn-icon btn-xs valign-text-bottom"><i class="icon-people"></i></a>
</li>
<li class="text-left">
<div class="text-semibold">Total online</div>
<div class="text-muted"><span class="status-mark border-success position-left"></span> 5,378 avg</div>
</li>
</ul>
<div class="col-lg-10 col-lg-offset-1">
<div class="chart content-group" id="total-online"></div>
</div>
</div>
</div>
</div>
<div class="chart position-relative" id="traffic-sources"></div>
</div>
<!-- /traffic sources -->
</div>
<div class="col-lg-5">
<!-- Sales stats -->
<div class="panel panel-flat">
<div class="panel-heading">
<h6 class="panel-title">Sales statistics</h6>
<div class="heading-elements">
<form class="heading-form" action="#">
<div class="form-group">
<select class="change-date select-sm" id="select_date">
<optgroup label="<i class='icon-watch pull-right'></i> Time period">
<option value="val1">June, 29 - July, 5</option>
<option value="val2">June, 22 - June 28</option>
<option value="val3" selected="selected">June, 15 - June, 21</option>
<option value="val4">June, 8 - June, 14</option>
</optgroup>
</select>
</div>
</form>
</div>
</div>
<div class="container-fluid">
<div class="row text-center">
<div class="col-md-4">
<div class="content-group">
<h5 class="text-semibold no-margin"><i class="icon-calendar5 position-left text-slate"></i> 5,689</h5>
<span class="text-muted text-size-small">orders weekly</span>
</div>
</div>
<div class="col-md-4">
<div class="content-group">
<h5 class="text-semibold no-margin"><i class="icon-calendar52 position-left text-slate"></i> 32,568</h5>
<span class="text-muted text-size-small">orders monthly</span>
</div>
</div>
<div class="col-md-4">
<div class="content-group">
<h5 class="text-semibold no-margin"><i class="icon-cash3 position-left text-slate"></i> $23,464</h5>
<span class="text-muted text-size-small">average revenue</span>
</div>
</div>
</div>
</div>
<div class="chart content-group-sm" id="app_sales"></div>
<div class="chart" id="monthly-sales-stats"></div>
</div>
<!-- /sales stats -->
</div>
</div>
<!-- /main charts -->
<!-- Dashboard content -->
<div class="row">
<div class="col-lg-8">
<!-- Marketing campaigns -->
<div class="panel panel-flat">
<div class="panel-heading">
<h6 class="panel-title">Marketing campaigns</h6>
<div class="heading-elements">
<span class="label bg-success heading-text">28 active</span>
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i> <span class="caret"></span></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-sync"></i> Update data</a></li>
<li><a href="#"><i class="icon-list-unordered"></i> Detailed log</a></li>
<li><a href="#"><i class="icon-pie5"></i> Statistics</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-cross3"></i> Clear list</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="table-responsive">
<table class="table table-lg text-nowrap">
<tbody>
<tr>
<td class="col-md-5">
<div class="media-left">
<div class="chart" id="campaigns-donut"></div>
</div>
<div class="media-left">
<h5 class="text-semibold no-margin">38,289 <small class="text-success text-size-base"><i class="icon-arrow-up12"></i> (+16.2%)</small></h5>
<ul class="list-inline list-inline-condensed no-margin">
<li>
<span class="status-mark border-success"></span>
</li>
<li>
<span class="text-muted">May 12, 12:30 am</span>
</li>
</ul>
</div>
</td>
<td class="col-md-5">
<div class="media-left">
<div class="chart" id="campaign-status-pie"></div>
</div>
<div class="media-left">
<h5 class="text-semibold no-margin">2,458 <small class="text-danger text-size-base"><i class="icon-arrow-down12"></i> (- 4.9%)</small></h5>
<ul class="list-inline list-inline-condensed no-margin">
<li>
<span class="status-mark border-danger"></span>
</li>
<li>
<span class="text-muted">Jun 4, 4:00 am</span>
</li>
</ul>
</div>
</td>
<td class="text-right col-md-2">
<a href="#" class="btn bg-indigo-300"><i class="icon-statistics position-left"></i> View report</a>
</td>
</tr>
</tbody>
</table>
</div>
<div class="table-responsive">
<table class="table text-nowrap">
<thead>
<tr>
<th>Campaign</th>
<th class="col-md-2">Client</th>
<th class="col-md-2">Changes</th>
<th class="col-md-2">Budget</th>
<th class="col-md-2">Status</th>
<th class="text-center" style="width: 20px;"><i class="icon-arrow-down12"></i></th>
</tr>
</thead>
<tbody>
<tr class="active border-double">
<td colspan="5">Today</td>
<td class="text-right">
<span class="progress-meter" id="today-progress" data-progress="30"></span>
</td>
</tr>
<tr>
<td>
<div class="media-left media-middle">
<a href="#"><img src="../../../../global_assets/images/brands/facebook.png" class="img-circle img-xs" alt=""></a>
</div>
<div class="media-left">
<div class=""><a href="#" class="text-default text-semibold">Facebook</a></div>
<div class="text-muted text-size-small">
<span class="status-mark border-blue position-left"></span>
02:00 - 03:00
</div>
</div>
</td>
<td><span class="text-muted">Mintlime</span></td>
<td><span class="text-success-600"><i class="icon-stats-growth2 position-left"></i> 2.43%</span></td>
<td><h6 class="text-semibold">$5,489</h6></td>
<td><span class="label bg-blue">Active</span></td>
<td class="text-center">
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-file-stats"></i> View statement</a></li>
<li><a href="#"><i class="icon-file-text2"></i> Edit campaign</a></li>
<li><a href="#"><i class="icon-file-locked"></i> Disable campaign</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-gear"></i> Settings</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr>
<td>
<div class="media-left media-middle">
<a href="#"><img src="../../../../global_assets/images/brands/youtube.png" class="img-circle img-xs" alt=""></a>
</div>
<div class="media-left">
<div class=""><a href="#" class="text-default text-semibold">Youtube videos</a></div>
<div class="text-muted text-size-small">
<span class="status-mark border-danger position-left"></span>
13:00 - 14:00
</div>
</div>
</td>
<td><span class="text-muted">CDsoft</span></td>
<td><span class="text-success-600"><i class="icon-stats-growth2 position-left"></i> 3.12%</span></td>
<td><h6 class="text-semibold">$2,592</h6></td>
<td><span class="label bg-danger">Closed</span></td>
<td class="text-center">
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-file-stats"></i> View statement</a></li>
<li><a href="#"><i class="icon-file-text2"></i> Edit campaign</a></li>
<li><a href="#"><i class="icon-file-locked"></i> Disable campaign</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-gear"></i> Settings</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr>
<td>
<div class="media-left media-middle">
<a href="#"><img src="../../../../global_assets/images/brands/spotify.png" class="img-circle img-xs" alt=""></a>
</div>
<div class="media-left">
<div class=""><a href="#" class="text-default text-semibold">Spotify ads</a></div>
<div class="text-muted text-size-small">
<span class="status-mark border-grey-400 position-left"></span>
10:00 - 11:00
</div>
</div>
</td>
<td><span class="text-muted">Diligence</span></td>
<td><span class="text-danger"><i class="icon-stats-decline2 position-left"></i> - 8.02%</span></td>
<td><h6 class="text-semibold">$1,268</h6></td>
<td><span class="label bg-grey-400">Hold</span></td>
<td class="text-center">
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-file-stats"></i> View statement</a></li>
<li><a href="#"><i class="icon-file-text2"></i> Edit campaign</a></li>
<li><a href="#"><i class="icon-file-locked"></i> Disable campaign</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-gear"></i> Settings</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr>
<td>
<div class="media-left media-middle">
<a href="#"><img src="../../../../global_assets/images/brands/twitter.png" class="img-circle img-xs" alt=""></a>
</div>
<div class="media-left">
<div class=""><a href="#" class="text-default text-semibold">Twitter ads</a></div>
<div class="text-muted text-size-small">
<span class="status-mark border-grey-400 position-left"></span>
04:00 - 05:00
</div>
</div>
</td>
<td><span class="text-muted">Deluxe</span></td>
<td><span class="text-success-600"><i class="icon-stats-growth2 position-left"></i> 2.78%</span></td>
<td><h6 class="text-semibold">$7,467</h6></td>
<td><span class="label bg-grey-400">Hold</span></td>
<td class="text-center">
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-file-stats"></i> View statement</a></li>
<li><a href="#"><i class="icon-file-text2"></i> Edit campaign</a></li>
<li><a href="#"><i class="icon-file-locked"></i> Disable campaign</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-gear"></i> Settings</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr class="active border-double">
<td colspan="5">Yesterday</td>
<td class="text-right">
<span class="progress-meter" id="yesterday-progress" data-progress="65"></span>
</td>
</tr>
<tr>
<td>
<div class="media-left media-middle">
<a href="#"><img src="../../../../global_assets/images/brands/bing.png" class="img-circle img-xs" alt=""></a>
</div>
<div class="media-left">
<div class=""><a href="#" class="text-default text-semibold">Bing campaign</a></div>
<div class="text-muted text-size-small">
<span class="status-mark border-success position-left"></span>
15:00 - 16:00
</div>
</div>
</td>
<td><span class="text-muted">Metrics</span></td>
<td><span class="text-danger"><i class="icon-stats-decline2 position-left"></i> - 5.78%</span></td>
<td><h6 class="text-semibold">$970</h6></td>
<td><span class="label bg-success-400">Pending</span></td>
<td class="text-center">
<ul class="icons-list">
<li class="dropup">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-file-stats"></i> View statement</a></li>
<li><a href="#"><i class="icon-file-text2"></i> Edit campaign</a></li>
<li><a href="#"><i class="icon-file-locked"></i> Disable campaign</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-gear"></i> Settings</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr>
<td>
<div class="media-left media-middle">
<a href="#"><img src="../../../../global_assets/images/brands/amazon.png" class="img-circle img-xs" alt=""></a>
</div>
<div class="media-left">
<div class=""><a href="#" class="text-default text-semibold">Amazon ads</a></div>
<div class="text-muted text-size-small">
<span class="status-mark border-danger position-left"></span>
18:00 - 19:00
</div>
</div>
</td>
<td><span class="text-muted">Blueish</span></td>
<td><span class="text-success-600"><i class="icon-stats-growth2 position-left"></i> 6.79%</span></td>
<td><h6 class="text-semibold">$1,540</h6></td>
<td><span class="label bg-blue">Active</span></td>
<td class="text-center">
<ul class="icons-list">
<li class="dropup">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-file-stats"></i> View statement</a></li>
<li><a href="#"><i class="icon-file-text2"></i> Edit campaign</a></li>
<li><a href="#"><i class="icon-file-locked"></i> Disable campaign</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-gear"></i> Settings</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr>
<td>
<div class="media-left media-middle">
<a href="#"><img src="../../../../global_assets/images/brands/dribbble.png" class="img-circle img-xs" alt=""></a>
</div>
<div class="media-left">
<div class=""><a href="#" class="text-default text-semibold">Dribbble ads</a></div>
<div class="text-muted text-size-small">
<span class="status-mark border-blue position-left"></span>
20:00 - 21:00
</div>
</div>
</td>
<td><span class="text-muted">Teamable</span></td>
<td><span class="text-danger"><i class="icon-stats-decline2 position-left"></i> 9.83%</span></td>
<td><h6 class="text-semibold">$8,350</h6></td>
<td><span class="label bg-danger">Closed</span></td>
<td class="text-center">
<ul class="icons-list">
<li class="dropup">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-file-stats"></i> View statement</a></li>
<li><a href="#"><i class="icon-file-text2"></i> Edit campaign</a></li>
<li><a href="#"><i class="icon-file-locked"></i> Disable campaign</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-gear"></i> Settings</a></li>
</ul>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<!-- /marketing campaigns -->
<!-- Quick stats boxes -->
<div class="row">
<div class="col-lg-4">
<!-- Members online -->
<div class="panel bg-teal-400">
<div class="panel-body">
<div class="heading-elements">
<span class="heading-text badge bg-teal-800">+53,6%</span>
</div>
<h3 class="no-margin">3,450</h3>
Members online
<div class="text-muted text-size-small">489 avg</div>
</div>
<div class="container-fluid">
<div class="chart" id="members-online"></div>
</div>
</div>
<!-- /members online -->
</div>
<div class="col-lg-4">
<!-- Current server load -->
<div class="panel bg-pink-400">
<div class="panel-body">
<div class="heading-elements">
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-cog3"></i> <span class="caret"></span></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-sync"></i> Update data</a></li>
<li><a href="#"><i class="icon-list-unordered"></i> Detailed log</a></li>
<li><a href="#"><i class="icon-pie5"></i> Statistics</a></li>
<li><a href="#"><i class="icon-cross3"></i> Clear list</a></li>
</ul>
</li>
</ul>
</div>
<h3 class="no-margin">49.4%</h3>
Current server load
<div class="text-muted text-size-small">34.6% avg</div>
</div>
<div class="chart" id="server-load"></div>
</div>
<!-- /current server load -->
</div>
<div class="col-lg-4">
<!-- Today's revenue -->
<div class="panel bg-blue-400">
<div class="panel-body">
<div class="heading-elements">
<ul class="icons-list">
<li><a data-action="reload"></a></li>
</ul>
</div>
<h3 class="no-margin">$18,390</h3>
Today's revenue
<div class="text-muted text-size-small">$37,578 avg</div>
</div>
<div class="chart" id="today-revenue"></div>
</div>
<!-- /today's revenue -->
</div>
</div>
<!-- /quick stats boxes -->
<!-- Support tickets -->
<div class="panel panel-flat">
<div class="panel-heading">
<h6 class="panel-title">Support tickets</h6>
<div class="heading-elements">
<button type="button" class="btn btn-link daterange-ranges heading-btn text-semibold">
<i class="icon-calendar3 position-left"></i> <span></span> <b class="caret"></b>
</button>
</div>
</div>
<div class="table-responsive">
<table class="table table-xlg text-nowrap">
<tbody>
<tr>
<td class="col-md-4">
<div class="media-left media-middle">
<div class="chart" id="tickets-status"></div>
</div>
<div class="media-left">
<h5 class="text-semibold no-margin">14,327 <small class="text-success text-size-base"><i class="icon-arrow-up12"></i> (+2.9%)</small></h5>
<span class="text-muted"><span class="status-mark border-success position-left"></span> Jun 16, 10:00 am</span>
</div>
</td>
<td class="col-md-3">
<div class="media-left media-middle">
<a href="#" class="btn border-indigo-400 text-indigo-400 btn-flat btn-rounded btn-xs btn-icon"><i class="icon-alarm-add"></i></a>
</div>
<div class="media-left">
<h5 class="text-semibold no-margin">
1,132 <small class="display-block no-margin">total tickets</small>
</h5>
</div>
</td>
<td class="col-md-3">
<div class="media-left media-middle">
<a href="#" class="btn border-indigo-400 text-indigo-400 btn-flat btn-rounded btn-xs btn-icon"><i class="icon-spinner11"></i></a>
</div>
<div class="media-left">
<h5 class="text-semibold no-margin">
06:25:00 <small class="display-block no-margin">response time</small>
</h5>
</div>
</td>
<td class="text-right col-md-2">
<a href="#" class="btn bg-teal-400"><i class="icon-statistics position-left"></i> Report</a>
</td>
</tr>
</tbody>
</table>
</div>
<div class="table-responsive">
<table class="table text-nowrap">
<thead>
<tr>
<th style="width: 50px">Due</th>
<th style="width: 300px;">User</th>
<th>Description</th>
<th class="text-center" style="width: 20px;"><i class="icon-arrow-down12"></i></th>
</tr>
</thead>
<tbody>
<tr class="active border-double">
<td colspan="3">Active tickets</td>
<td class="text-right">
<span class="badge bg-blue">24</span>
</td>
</tr>
<tr>
<td class="text-center">
<h6 class="no-margin">12 <small class="display-block text-size-small no-margin">hours</small></h6>
</td>
<td>
<div class="media-left media-middle">
<a href="#" class="btn bg-teal-400 btn-rounded btn-icon btn-xs">
<span class="letter-icon"></span>
</a>
</div>
<div class="media-body">
<a href="#" class="display-inline-block text-default text-semibold letter-icon-title">Annabelle Doney</a>
<div class="text-muted text-size-small"><span class="status-mark border-blue position-left"></span> Active</div>
</div>
</td>
<td>
<a href="#" class="text-default display-inline-block">
<span class="text-semibold">[#1183] Workaround for OS X selects printing bug</span>
<span class="display-block text-muted">Chrome fixed the bug several versions ago, thus rendering this...</span>
</a>
</td>
<td class="text-center">
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-undo"></i> Quick reply</a></li>
<li><a href="#"><i class="icon-history"></i> Full history</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-checkmark3 text-success"></i> Resolve issue</a></li>
<li><a href="#"><i class="icon-cross2 text-danger"></i> Close issue</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr>
<td class="text-center">
<h6 class="no-margin">16 <small class="display-block text-size-small no-margin">hours</small></h6>
</td>
<td>
<div class="media-left media-middle">
<a href="#"><img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-xs" alt=""></a>
</div>
<div class="media-body">
<a href="#" class="display-inline-block text-default text-semibold letter-icon-title">Chris Macintyre</a>
<div class="text-muted text-size-small"><span class="status-mark border-blue position-left"></span> Active</div>
</div>
</td>
<td>
<a href="#" class="text-default display-inline-block">
<span class="text-semibold">[#1249] Vertically center carousel controls</span>
<span class="display-block text-muted">Try any carousel control and reduce the screen width below...</span>
</a>
</td>
<td class="text-center">
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-undo"></i> Quick reply</a></li>
<li><a href="#"><i class="icon-history"></i> Full history</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-checkmark3 text-success"></i> Resolve issue</a></li>
<li><a href="#"><i class="icon-cross2 text-danger"></i> Close issue</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr>
<td class="text-center">
<h6 class="no-margin">20 <small class="display-block text-size-small no-margin">hours</small></h6>
</td>
<td>
<div class="media-left media-middle">
<a href="#" class="btn bg-blue btn-rounded btn-icon btn-xs">
<span class="letter-icon"></span>
</a>
</div>
<div class="media-body">
<a href="#" class="display-inline-block text-default text-semibold letter-icon-title">Robert Hauber</a>
<div class="text-muted text-size-small"><span class="status-mark border-blue position-left"></span> Active</div>
</div>
</td>
<td>
<a href="#" class="text-default display-inline-block">
<span class="text-semibold">[#1254] Inaccurate small pagination height</span>
<span class="display-block text-muted">The height of pagination elements is not consistent with...</span>
</a>
</td>
<td class="text-center">
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-undo"></i> Quick reply</a></li>
<li><a href="#"><i class="icon-history"></i> Full history</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-checkmark3 text-success"></i> Resolve issue</a></li>
<li><a href="#"><i class="icon-cross2 text-danger"></i> Close issue</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr>
<td class="text-center">
<h6 class="no-margin">40 <small class="display-block text-size-small no-margin">hours</small></h6>
</td>
<td>
<div class="media-left media-middle">
<a href="#" class="btn bg-warning-400 btn-rounded btn-icon btn-xs">
<span class="letter-icon"></span>
</a>
</div>
<div class="media-body">
<a href="#" class="display-inline-block text-default text-semibold letter-icon-title">Dex Sponheim</a>
<div class="text-muted text-size-small"><span class="status-mark border-blue position-left"></span> Active</div>
</div>
</td>
<td>
<a href="#" class="text-default display-inline-block">
<span class="text-semibold">[#1184] Round grid column gutter operations</span>
<span class="display-block text-muted">Left rounds up, right rounds down. should keep everything...</span>
</a>
</td>
<td class="text-center">
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-undo"></i> Quick reply</a></li>
<li><a href="#"><i class="icon-history"></i> Full history</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-checkmark3 text-success"></i> Resolve issue</a></li>
<li><a href="#"><i class="icon-cross2 text-danger"></i> Close issue</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr class="active border-double">
<td colspan="3">Resolved tickets</td>
<td class="text-right">
<span class="badge bg-success">42</span>
</td>
</tr>
<tr>
<td class="text-center">
<i class="icon-checkmark3 text-success"></i>
</td>
<td>
<div class="media-left media-middle">
<a href="#" class="btn bg-success-400 btn-rounded btn-icon btn-xs">
<span class="letter-icon"></span>
</a>
</div>
<div class="media-body">
<a href="#" class="display-inline-block text-default letter-icon-title">Alan Macedo</a>
<div class="text-muted text-size-small"><span class="status-mark border-success position-left"></span> Resolved</div>
</div>
</td>
<td>
<a href="#" class="text-default display-inline-block">
[#1046] Avoid some unnecessary HTML string
<span class="display-block text-muted">Rather than building a string of HTML and then parsing it...</span>
</a>
</td>
<td class="text-center">
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-undo"></i> Quick reply</a></li>
<li><a href="#"><i class="icon-history"></i> Full history</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-plus3 text-blue"></i> Unresolve issue</a></li>
<li><a href="#"><i class="icon-cross2 text-danger"></i> Close issue</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr>
<td class="text-center">
<i class="icon-checkmark3 text-success"></i>
</td>
<td>
<div class="media-left media-middle">
<a href="#" class="btn bg-pink-400 btn-rounded btn-icon btn-xs">
<span class="letter-icon"></span>
</a>
</div>
<div class="media-body">
<a href="#" class="display-inline-block text-default letter-icon-title">Brett Castellano</a>
<div class="text-muted text-size-small"><span class="status-mark border-success position-left"></span> Resolved</div>
</div>
</td>
<td>
<a href="#" class="text-default display-inline-block">
[#1038] Update json configuration
<span class="display-block text-muted">The <code>files</code> property is necessary to override the files property...</span>
</a>
</td>
<td class="text-center">
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-undo"></i> Quick reply</a></li>
<li><a href="#"><i class="icon-history"></i> Full history</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-plus3 text-blue"></i> Unresolve issue</a></li>
<li><a href="#"><i class="icon-cross2 text-danger"></i> Close issue</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr>
<td class="text-center">
<i class="icon-checkmark3 text-success"></i>
</td>
<td>
<div class="media-left media-middle">
<a href="#"><img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-xs" alt=""></a>
</div>
<div class="media-body">
<a href="#" class="display-inline-block text-default">Roxanne Forbes</a>
<div class="text-muted text-size-small"><span class="status-mark border-success position-left"></span> Resolved</div>
</div>
</td>
<td>
<a href="#" class="text-default display-inline-block">
[#1034] Tooltip multiple event
<span class="display-block text-muted">Fix behavior when using tooltips and popovers that are...</span>
</a>
</td>
<td class="text-center">
<ul class="icons-list">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-undo"></i> Quick reply</a></li>
<li><a href="#"><i class="icon-history"></i> Full history</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-plus3 text-blue"></i> Unresolve issue</a></li>
<li><a href="#"><i class="icon-cross2 text-danger"></i> Close issue</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr class="active border-double">
<td colspan="3">Closed tickets</td>
<td class="text-right">
<span class="badge bg-danger">37</span>
</td>
</tr>
<tr>
<td class="text-center">
<i class="icon-cross2 text-danger-400"></i>
</td>
<td>
<div class="media-left media-middle">
<a href="#"><img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-xs" alt=""></a>
</div>
<div class="media-body">
<a href="#" class="display-inline-block text-default">Mitchell Sitkin</a>
<div class="text-muted text-size-small"><span class="status-mark border-danger position-left"></span> Closed</div>
</div>
</td>
<td>
<a href="#" class="text-default display-inline-block">
[#1040] Account for static form controls in form group
<span class="display-block text-muted">Resizes control label's font-size and account for the standard...</span>
</a>
</td>
<td class="text-center">
<ul class="icons-list">
<li class="dropup">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-undo"></i> Quick reply</a></li>
<li><a href="#"><i class="icon-history"></i> Full history</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-reload-alt text-blue"></i> Reopen issue</a></li>
<li><a href="#"><i class="icon-cross2 text-danger"></i> Close issue</a></li>
</ul>
</li>
</ul>
</td>
</tr>
<tr>
<td class="text-center">
<i class="icon-cross2 text-danger"></i>
</td>
<td>
<div class="media-left media-middle">
<a href="#" class="btn bg-brown-400 btn-rounded btn-icon btn-xs">
<span class="letter-icon"></span>
</a>
</div>
<div class="media-body">
<a href="#" class="display-inline-block text-default letter-icon-title">Katleen Jensen</a>
<div class="text-muted text-size-small"><span class="status-mark border-danger position-left"></span> Closed</div>
</div>
</td>
<td>
<a href="#" class="text-default display-inline-block">
[#1038] Proper sizing of form control feedback
<span class="display-block text-muted">Feedback icon sizing inside a larger/smaller form-group...</span>
</a>
</td>
<td class="text-center">
<ul class="icons-list">
<li class="dropup">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-menu7"></i></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-undo"></i> Quick reply</a></li>
<li><a href="#"><i class="icon-history"></i> Full history</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-plus3 text-blue"></i> Unresolve issue</a></li>
<li><a href="#"><i class="icon-cross2 text-danger"></i> Close issue</a></li>
</ul>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<!-- /support tickets -->
<!-- Latest posts -->
<div class="panel panel-flat">
<div class="panel-heading">
<h6 class="panel-title">Latest posts</h6>
<div class="heading-elements">
<ul class="icons-list">
<li><a data-action="collapse"></a></li>
<li><a data-action="reload"></a></li>
<li><a data-action="close"></a></li>
</ul>
</div>
</div>
<div class="panel-body">
<div class="row">
<div class="col-lg-6">
<ul class="media-list content-group">
<li class="media stack-media-on-mobile">
<div class="media-left">
<div class="thumb">
<a href="#">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-responsive img-rounded media-preview" alt="">
<span class="zoom-image"><i class="icon-play3"></i></span>
</a>
</div>
</div>
<div class="media-body">
<h6 class="media-heading"><a href="#">Up unpacked friendly</a></h6>
<ul class="list-inline list-inline-separate text-muted mb-5">
<li><i class="icon-book-play position-left"></i> Video tutorials</li>
<li>14 minutes ago</li>
</ul>
The him father parish looked has sooner. Attachment frequently gay terminated son...
</div>
</li>
<li class="media stack-media-on-mobile">
<div class="media-left">
<div class="thumb">
<a href="#">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-responsive img-rounded media-preview" alt="">
<span class="zoom-image"><i class="icon-play3"></i></span>
</a>
</div>
</div>
<div class="media-body">
<h6 class="media-heading"><a href="#">It allowance prevailed</a></h6>
<ul class="list-inline list-inline-separate text-muted mb-5">
<li><i class="icon-book-play position-left"></i> Video tutorials</li>
<li>12 days ago</li>
</ul>
Alteration literature to or an sympathize mr imprudence. Of is ferrars subject as enjoyed...
</div>
</li>
</ul>
</div>
<div class="col-lg-6">
<ul class="media-list content-group">
<li class="media stack-media-on-mobile">
<div class="media-left">
<div class="thumb">
<a href="#">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-responsive img-rounded media-preview" alt="">
<span class="zoom-image"><i class="icon-play3"></i></span>
</a>
</div>
</div>
<div class="media-body">
<h6 class="media-heading"><a href="#">Case read they must</a></h6>
<ul class="list-inline list-inline-separate text-muted mb-5">
<li><i class="icon-book-play position-left"></i> Video tutorials</li>
<li>20 hours ago</li>
</ul>
On it differed repeated wandered required in. Then girl neat why yet knew rose spot...
</div>
</li>
<li class="media stack-media-on-mobile">
<div class="media-left">
<div class="thumb">
<a href="#">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-responsive img-rounded media-preview" alt="">
<span class="zoom-image"><i class="icon-play3"></i></span>
</a>
</div>
</div>
<div class="media-body">
<h6 class="media-heading"><a href="#">Too carriage attended</a></h6>
<ul class="list-inline list-inline-separate text-muted mb-5">
<li><i class="icon-book-play position-left"></i> FAQ section</li>
<li>2 days ago</li>
</ul>
Marianne or husbands if at stronger ye. Considered is as middletons uncommonly...
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<!-- /latest posts -->
</div>
<div class="col-lg-4">
<!-- Progress counters -->
<div class="row">
<div class="col-md-6">
<!-- Available hours -->
<div class="panel text-center">
<div class="panel-body">
<div class="heading-elements">
<ul class="icons-list">
<li class="dropdown text-muted">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-cog3"></i> <span class="caret"></span></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-sync"></i> Update data</a></li>
<li><a href="#"><i class="icon-list-unordered"></i> Detailed log</a></li>
<li><a href="#"><i class="icon-pie5"></i> Statistics</a></li>
<li><a href="#"><i class="icon-cross3"></i> Clear list</a></li>
</ul>
</li>
</ul>
</div>
<!-- Progress counter -->
<div class="chart content-group-sm svg-center position-relative" id="hours-available-progress"></div>
<!-- /progress counter -->
<!-- Bars -->
<div class="chart" id="hours-available-bars"></div>
<!-- /bars -->
</div>
</div>
<!-- /available hours -->
</div>
<div class="col-md-6">
<!-- Productivity goal -->
<div class="panel text-center">
<div class="panel-body">
<div class="heading-elements">
<ul class="icons-list">
<li class="dropdown text-muted">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-cog3"></i> <span class="caret"></span></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-sync"></i> Update data</a></li>
<li><a href="#"><i class="icon-list-unordered"></i> Detailed log</a></li>
<li><a href="#"><i class="icon-pie5"></i> Statistics</a></li>
<li><a href="#"><i class="icon-cross3"></i> Clear list</a></li>
</ul>
</li>
</ul>
</div>
<!-- Progress counter -->
<div class="chart content-group-sm svg-center position-relative" id="goal-progress"></div>
<!-- /progress counter -->
<!-- Bars -->
<div class="chart" id="goal-bars"></div>
<!-- /bars -->
</div>
</div>
<!-- /productivity goal -->
</div>
</div>
<!-- /progress counters -->
<!-- Daily sales -->
<div class="panel panel-flat">
<div class="panel-heading">
<h6 class="panel-title">Daily sales stats</h6>
<div class="heading-elements">
<span class="heading-text">Balance: <span class="text-bold text-danger-600 position-right">$4,378</span></span>
<ul class="icons-list">
<li class="dropdown text-muted">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="icon-cog3"></i> <span class="caret"></span></a>
<ul class="dropdown-menu dropdown-menu-right">
<li><a href="#"><i class="icon-sync"></i> Update data</a></li>
<li><a href="#"><i class="icon-list-unordered"></i> Detailed log</a></li>
<li><a href="#"><i class="icon-pie5"></i> Statistics</a></li>
<li class="divider"></li>
<li><a href="#"><i class="icon-cross3"></i> Clear list</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="panel-body">
<div class="chart" id="sales-heatmap"></div>
</div>
<div class="table-responsive">
<table class="table text-nowrap">
<thead>
<tr>
<th>Application</th>
<th>Time</th>
<th>Price</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<div class="media-left media-middle">
<a href="#" class="btn bg-primary-400 btn-rounded btn-icon btn-xs">
<span class="letter-icon"></span>
</a>
</div>
<div class="media-body">
<div class="media-heading">
<a href="#" class="letter-icon-title">Sigma application</a>
</div>
<div class="text-muted text-size-small"><i class="icon-checkmark3 text-size-mini position-left"></i> New order</div>
</div>
</td>
<td>
<span class="text-muted text-size-small">06:28 pm</span>
</td>
<td>
<h6 class="text-semibold no-margin">$49.90</h6>
</td>
</tr>
<tr>
<td>
<div class="media-left media-middle">
<a href="#" class="btn bg-danger-400 btn-rounded btn-icon btn-xs">
<span class="letter-icon"></span>
</a>
</div>
<div class="media-body">
<div class="media-heading">
<a href="#" class="letter-icon-title">Alpha application</a>
</div>
<div class="text-muted text-size-small"><i class="icon-spinner11 text-size-mini position-left"></i> Renewal</div>
</div>
</td>
<td>
<span class="text-muted text-size-small">04:52 pm</span>
</td>
<td>
<h6 class="text-semibold no-margin">$90.50</h6>
</td>
</tr>
<tr>
<td>
<div class="media-left media-middle">
<a href="#" class="btn bg-indigo-400 btn-rounded btn-icon btn-xs">
<span class="letter-icon"></span>
</a>
</div>
<div class="media-body">
<div class="media-heading">
<a href="#" class="letter-icon-title">Delta application</a>
</div>
<div class="text-muted text-size-small"><i class="icon-lifebuoy text-size-mini position-left"></i> Support</div>
</div>
</td>
<td>
<span class="text-muted text-size-small">01:26 pm</span>
</td>
<td>
<h6 class="text-semibold no-margin">$60.00</h6>
</td>
</tr>
<tr>
<td>
<div class="media-left media-middle">
<a href="#" class="btn bg-success-400 btn-rounded btn-icon btn-xs">
<span class="letter-icon"></span>
</a>
</div>
<div class="media-body">
<div class="media-heading">
<a href="#" class="letter-icon-title">Omega application</a>
</div>
<div class="text-muted text-size-small"><i class="icon-lifebuoy text-size-mini position-left"></i> Support</div>
</div>
</td>
<td>
<span class="text-muted text-size-small">11:46 am</span>
</td>
<td>
<h6 class="text-semibold no-margin">$55.00</h6>
</td>
</tr>
<tr>
<td>
<div class="media-left media-middle">
<a href="#" class="btn bg-danger-400 btn-rounded btn-icon btn-xs">
<span class="letter-icon"></span>
</a>
</div>
<div class="media-body">
<div class="media-heading">
<a href="#" class="letter-icon-title">Alpha application</a>
</div>
<div class="text-muted text-size-small"><i class="icon-spinner11 text-size-mini position-left"></i> Renewal</div>
</div>
</td>
<td>
<span class="text-muted text-size-small">10:29 am</span>
</td>
<td>
<h6 class="text-semibold no-margin">$90.50</h6>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<!-- /daily sales -->
<!-- My messages -->
<div class="panel panel-flat">
<div class="panel-heading">
<h6 class="panel-title">My messages</h6>
<div class="heading-elements">
<span class="heading-text"><i class="icon-history text-warning position-left"></i> Jul 7, 10:30</span>
<span class="label bg-success heading-text">Online</span>
</div>
</div>
<!-- Numbers -->
<div class="container-fluid">
<div class="row text-center">
<div class="col-md-4">
<div class="content-group">
<h6 class="text-semibold no-margin"><i class="icon-clipboard3 position-left text-slate"></i> 2,345</h6>
<span class="text-muted text-size-small">this week</span>
</div>
</div>
<div class="col-md-4">
<div class="content-group">
<h6 class="text-semibold no-margin"><i class="icon-calendar3 position-left text-slate"></i> 3,568</h6>
<span class="text-muted text-size-small">this month</span>
</div>
</div>
<div class="col-md-4">
<div class="content-group">
<h6 class="text-semibold no-margin"><i class="icon-comments position-left text-slate"></i> 32,693</h6>
<span class="text-muted text-size-small">all messages</span>
</div>
</div>
</div>
</div>
<!-- /numbers -->
<!-- Area chart -->
<div class="chart" id="messages-stats"></div>
<!-- /area chart -->
<!-- Tabs -->
<ul class="nav nav-lg nav-tabs nav-justified no-margin no-border-radius bg-indigo-400 border-top border-top-indigo-300">
<li class="active">
<a href="#messages-tue" class="text-size-small text-uppercase" data-toggle="tab">
Tuesday
</a>
</li>
<li>
<a href="#messages-mon" class="text-size-small text-uppercase" data-toggle="tab">
Monday
</a>
</li>
<li>
<a href="#messages-fri" class="text-size-small text-uppercase" data-toggle="tab">
Friday
</a>
</li>
</ul>
<!-- /tabs -->
<!-- Tabs content -->
<div class="tab-content">
<div class="tab-pane active fade in has-padding" id="messages-tue">
<ul class="media-list">
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-xs" alt="">
<span class="badge bg-danger-400 media-badge">8</span>
</div>
<div class="media-body">
<a href="#">
James Alexander
<span class="media-annotation pull-right">14:58</span>
</a>
<span class="display-block text-muted">The constitutionally inventoried precariously...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-xs" alt="">
<span class="badge bg-danger-400 media-badge">6</span>
</div>
<div class="media-body">
<a href="#">
Margo Baker
<span class="media-annotation pull-right">12:16</span>
</a>
<span class="display-block text-muted">Pinched a well more moral chose goodness...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-xs" alt="">
</div>
<div class="media-body">
<a href="#">
Jeremy Victorino
<span class="media-annotation pull-right">09:48</span>
</a>
<span class="display-block text-muted">Pert thickly mischievous clung frowned well...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-xs" alt="">
</div>
<div class="media-body">
<a href="#">
Beatrix Diaz
<span class="media-annotation pull-right">05:54</span>
</a>
<span class="display-block text-muted">Nightingale taped hello bucolic fussily cardinal...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-xs" alt="">
</div>
<div class="media-body">
<a href="#">
Richard Vango
<span class="media-annotation pull-right">01:43</span>
</a>
<span class="display-block text-muted">Amidst roadrunner distantly pompously where...</span>
</div>
</li>
</ul>
</div>
<div class="tab-pane fade has-padding" id="messages-mon">
<ul class="media-list">
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt="">
</div>
<div class="media-body">
<a href="#">
Isak Temes
<span class="media-annotation pull-right">Tue, 19:58</span>
</a>
<span class="display-block text-muted">Reasonable palpably rankly expressly grimy...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt="">
</div>
<div class="media-body">
<a href="#">
Vittorio Cosgrove
<span class="media-annotation pull-right">Tue, 16:35</span>
</a>
<span class="display-block text-muted">Arguably therefore more unexplainable fumed...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt="">
</div>
<div class="media-body">
<a href="#">
Hilary Talaugon
<span class="media-annotation pull-right">Tue, 12:16</span>
</a>
<span class="display-block text-muted">Nicely unlike porpoise a kookaburra past more...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt="">
</div>
<div class="media-body">
<a href="#">
Bobbie Seber
<span class="media-annotation pull-right">Tue, 09:20</span>
</a>
<span class="display-block text-muted">Before visual vigilantly fortuitous tortoise...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt="">
</div>
<div class="media-body">
<a href="#">
Walther Laws
<span class="media-annotation pull-right">Tue, 03:29</span>
</a>
<span class="display-block text-muted">Far affecting more leered unerringly dishonest...</span>
</div>
</li>
</ul>
</div>
<div class="tab-pane fade has-padding" id="messages-fri">
<ul class="media-list">
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt="">
</div>
<div class="media-body">
<a href="#">
Owen Stretch
<span class="media-annotation pull-right">Mon, 18:12</span>
</a>
<span class="display-block text-muted">Tardy rattlesnake seal raptly earthworm...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt="">
</div>
<div class="media-body">
<a href="#">
Jenilee Mcnair
<span class="media-annotation pull-right">Mon, 14:03</span>
</a>
<span class="display-block text-muted">Since hello dear pushed amid darn trite...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt="">
</div>
<div class="media-body">
<a href="#">
Alaster Jain
<span class="media-annotation pull-right">Mon, 13:59</span>
</a>
<span class="display-block text-muted">Dachshund cardinal dear next jeepers well...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt="">
</div>
<div class="media-body">
<a href="#">
Sigfrid Thisted
<span class="media-annotation pull-right">Mon, 09:26</span>
</a>
<span class="display-block text-muted">Lighted wolf yikes less lemur crud grunted...</span>
</div>
</li>
<li class="media">
<div class="media-left">
<img src="../../../../global_assets/images/placeholders/placeholder.jpg" class="img-circle img-sm" alt="">
</div>
<div class="media-body">
<a href="#">
Sherilyn Mckee
<span class="media-annotation pull-right">Mon, 06:38</span>
</a>
<span class="display-block text-muted">Less unicorn a however careless husky...</span>
</div>
</li>
</ul>
</div>
</div>
<!-- /tabs content -->
</div>
<!-- /my messages -->
<!-- Daily financials -->
<div class="panel panel-flat">
<div class="panel-heading">
<h6 class="panel-title">Daily financials</h6>
<div class="heading-elements">
<form class="heading-form" action="#">
<div class="form-group">
<label class="checkbox checkbox-inline checkbox-switchery checkbox-right switchery-xs">
<input type="checkbox" class="switcher" id="realtime" checked="checked">
Realtime
</label>
</div>
</form>
<span class="badge bg-danger-400 heading-text">+86</span>
</div>
</div>
<div class="panel-body">
<div class="chart content-group-xs" id="bullets"></div>
<ul class="media-list">
<li class="media">
<div class="media-left">
<a href="#" class="btn border-pink text-pink btn-flat btn-rounded btn-icon btn-xs"><i class="icon-statistics"></i></a>
</div>
<div class="media-body">
Stats for July, 6: 1938 orders, $4220 revenue
<div class="media-annotation">2 hours ago</div>
</div>
<div class="media-right media-middle">
<ul class="icons-list">
<li>
<a href="#"><i class="icon-arrow-right13"></i></a>
</li>
</ul>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn border-success text-success btn-flat btn-rounded btn-icon btn-xs"><i class="icon-checkmark3"></i></a>
</div>
<div class="media-body">
Invoices <a href="#">#4732</a> and <a href="#">#4734</a> have been paid
<div class="media-annotation">Dec 18, 18:36</div>
</div>
<div class="media-right media-middle">
<ul class="icons-list">
<li>
<a href="#"><i class="icon-arrow-right13"></i></a>
</li>
</ul>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn border-primary text-primary btn-flat btn-rounded btn-icon btn-xs"><i class="icon-alignment-unalign"></i></a>
</div>
<div class="media-body">
Affiliate commission for June has been paid
<div class="media-annotation">36 minutes ago</div>
</div>
<div class="media-right media-middle">
<ul class="icons-list">
<li>
<a href="#"><i class="icon-arrow-right13"></i></a>
</li>
</ul>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn border-warning-400 text-warning-400 btn-flat btn-rounded btn-icon btn-xs"><i class="icon-spinner11"></i></a>
</div>
<div class="media-body">
Order <a href="#">#37745</a> from July, 1st has been refunded
<div class="media-annotation">4 minutes ago</div>
</div>
<div class="media-right media-middle">
<ul class="icons-list">
<li>
<a href="#"><i class="icon-arrow-right13"></i></a>
</li>
</ul>
</div>
</li>
<li class="media">
<div class="media-left">
<a href="#" class="btn border-teal-400 text-teal btn-flat btn-rounded btn-icon btn-xs"><i class="icon-redo2"></i></a>
</div>
<div class="media-body">
Invoice <a href="#">#4769</a> has been sent to <a href="#">Robert Smith</a>
<div class="media-annotation">Dec 12, 05:46</div>
</div>
<div class="media-right media-middle">
<ul class="icons-list">
<li>
<a href="#"><i class="icon-arrow-right13"></i></a>
</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<!-- /daily financials -->
</div>
</div>
<!-- /dashboard content -->
<!-- Footer -->
<div class="footer text-muted">
© 2015. <a href="#">Limitless Web App Kit</a> by <a href="http://themeforest.net/user/Kopyov" target="_blank">Eugene Kopyov</a>
</div>
<!-- /footer -->
</div>
<!-- /content area -->
</div>
<!-- /main content -->
</div>
<!-- /page content -->
</div>
<!-- /page container -->
</body>
</html>
|
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Download Helper — CodeIgniter 3.0.4 documentation</title>
<link rel="shortcut icon" href="../_static/ci-icon.ico"/>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
<link rel="top" title="CodeIgniter 3.0.4 documentation" href="../index.html"/>
<link rel="up" title="Helpers" href="index.html"/>
<link rel="next" title="Email Helper" href="email_helper.html"/>
<link rel="prev" title="Directory Helper" href="directory_helper.html"/>
<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div id="nav">
<div id="nav_inner">
<div id="pulldown-menu" class="ciNav">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a><ul class="simple">
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
</ul>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Helpers</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="array_helper.html">Array Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="captcha_helper.html">CAPTCHA Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="cookie_helper.html">Cookie Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="date_helper.html">Date Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="directory_helper.html">Directory Helper</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="">Download Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="email_helper.html">Email Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="file_helper.html">File Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="form_helper.html">Form Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="html_helper.html">HTML Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="inflector_helper.html">Inflector Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="language_helper.html">Language Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="number_helper.html">Number Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="path_helper.html">Path Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="security_helper.html">Security Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="smiley_helper.html">Smiley Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="string_helper.html">String Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="text_helper.html">Text Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="typography_helper.html">Typography Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="url_helper.html">URL Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="xml_helper.html">XML Helper</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="nav2">
<a href="#" id="openToc">
<img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAKwCaAwERAAIRAQMRAf/EAHsAAQAABwEBAAAAAAAAAAAAAAABAwQFBgcIAgkBAQAAAAAAAAAAAAAAAAAAAAAQAAEDAwICBwYEAgsAAAAAAAIBAwQAEQUSBiEHkROTVNQWGDFBUVIUCHEiMtOUFWGBobHRQlMkZIRVEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwDSC+ygkOOaUoKigUCgUCgUCgUCgUCgUCgUCgkuGguIP9FBMFb0Hqg7We+3jlmIqqYFf4ub+/QYlnOR/LqIBKGFUbf8qWv971BytQXXE7Y3Lnm3HsFhp2TaZJAdchRXpIgSpdEJWxJEW3xoKV7F5OMy7JkQn2o7D6w33XGjEAkoiqrJEqIiOIiKuhePCgqp22dyYyS3CyWHnQ5joG61HkRnmnTbaFSMhExRVQRRVJU9iUHjE7ez+fJ0MFipmUNhBV8YUd2SoIV9KkjQla9ltegttBdPLW4/qocL+UTfrMiHW4+P9M71shuyrqaHTcxsl7jegpsji8nh5ZwMvDfgTm0RTjSmjYdFCS6KoOIipdFunCgmNYTMv457MMY6U7iI6oMieDDhRm1VbIhuoOkbqtuK0Hpzb+eZcYZexUxt6UyUqK2cd0SdjtgrhOgijcgERUlJOCIl6CpgbP3blRI8XgMjNARAyKNDfeRBdFDBVUAXgQrqH4pxoJTu2NysY97LP4ac1io5q1InHFeGO24LnVKJuKOkSQ/yKir+rh7aCLG1dzypZQI2FnvTgccYOM3FeN0XWERXAUEFVQgQkUktdLpegm+Td3/Xli/L+S/mYNJIOF9G/wBeLKrZHFb0akG6W1WtQWSg3Dyg5e7V3fipE3O4/wCrktyzYA+ufas2LbZIlmnAT2kvuoN1wft95augilglX/tzP3qCu9O3LL/wV/i5v79BvmTADq14UGu91467Z6U9y0HzH/ncj/U/sT/CgynZG7I2NezpZGUjIycJkYkZSG+uQ81pbBNKLxJfjwoMqZ3/ALYHl35AJ7/cuwHcu5k7r1Q5pHetBjquqVVJWGxj9Zrtcl/Ggy3dHMvauR3HFZj5nHNxSyW5JISYDMoIwx8tFIGHZhPNaykGapr6rUAiicEoMG21lMRj8buPAz8xhJrr7uOeiPTCyAwXUaGR1mgozbTusOsFLEiJ7fbQa/h7gcjy2H3V6xppwDNtUSxCJIqp7valBuWVzJ22xuCROXNNZiJkMtms0DbjUkAZjzoDrTMd9dDRI44ZC2YsrYdKWP2WDT2S3N9dNdlRYrGMYc06IURXSYb0igrpWS485xVNS6nF4rwslkoMwnbpgZLB7bmt5uMweAhDEl4B5uSLzzqTnnyVpW2jaJHRMSIjdDiiotvy3DOE5rYTEbkl5yFn28k7JyG4c7AU2HtLH1uKfaiMPI40CdYbpNtmLdwTSn5rewLNld+7TLdeal4WarWBkbVKBjgdElMJJwAAY5fl4kB3b1fp4XvagsGS3FjJfLzDNtS8aeXx7LzT7TyzByQE5PccRGRC0ZRUDRV6y62vbjagzLmJzS2vuPK43JY6aP1TW6Jz+RIWyFtyC06y3EkiiinAo7YCqfq1AqqnGgsOH3lhZO8d1pmcpB8j5XIm9OYlBJSQ/FSS4427DKO0RC8AlcEMhFdViRR1WDWR5t3WXVuL1d106kG9vdeye2g60+1FDyW0shIcXVpyroXt8I8dfd+NB1vioAdWnD3UF1+gD4UFc6CEKpagxXN43rwJLUHz7yX2c8zokt9uHlsPIhA4aRnnHJTLptIS6CNsY7iASpxUUMkReGpfbQW0vtN5pitvrsN28rwtBD0nc0+/Yft5XhaB6TuaXfsP28rwtA9J3NPv2H7eV4Wgek7mn37D9vK8LQPSdzT79h+3leFoHpO5pd+w/byvC0D0nc0u/Yft5XhaB6TuaXfsP28rwtA9J3NLv2H7eV4Wgek7ml37D9vK8LQPSdzS79h+3leFoHpO5p9+w/byvC0E9r7Reazy2HIYVPxkS/CUHVn26cosxyv2g7h89LYmZSXOenvLEQ1YaQ222RATcQCP8rSGqqA8S02W2pQ6FhMoAIlqCtsnwoCpdKClejI4i3Sgtb+GBxVuNBSFt1pV/RQefLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8utJ/koJ7WCbBU/LQXOPAFq1koK8B0pag90CggtBBf6qB0UDooHRQOigdFA6KB0UDooHRQOigdFA6KB0UDooI0EaBQf//Z" title="Toggle Table of Contents" alt="Toggle Table of Contents" />
</a>
</div>
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="../index.html" class="fa fa-home"> CodeIgniter</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a><ul class="simple">
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
</ul>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Helpers</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="array_helper.html">Array Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="captcha_helper.html">CAPTCHA Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="cookie_helper.html">Cookie Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="date_helper.html">Date Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="directory_helper.html">Directory Helper</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="">Download Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="email_helper.html">Email Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="file_helper.html">File Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="form_helper.html">Form Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="html_helper.html">HTML Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="inflector_helper.html">Inflector Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="language_helper.html">Language Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="number_helper.html">Number Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="path_helper.html">Path Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="security_helper.html">Security Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="smiley_helper.html">Smiley Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="string_helper.html">String Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="text_helper.html">Text Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="typography_helper.html">Typography Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="url_helper.html">URL Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="xml_helper.html">XML Helper</a></li>
</ul>
</li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">CodeIgniter</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li><a href="index.html">Helpers</a> »</li>
<li>Download Helper</li>
<li class="wy-breadcrumbs-aside">
</li>
<div style="float:right;margin-left:5px;" id="closeMe">
<img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" />
</div>
</ul>
<hr/>
</div>
<div role="main" class="document">
<div class="section" id="download-helper">
<h1>Download Helper<a class="headerlink" href="#download-helper" title="Permalink to this headline">¶</a></h1>
<p>The Download Helper lets you download data to your desktop.</p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#loading-this-helper" id="id1">Loading this Helper</a></li>
<li><a class="reference internal" href="#available-functions" id="id2">Available Functions</a></li>
</ul>
</div>
<div class="custom-index container"></div><div class="section" id="loading-this-helper">
<h2><a class="toc-backref" href="#id1">Loading this Helper</a><a class="headerlink" href="#loading-this-helper" title="Permalink to this headline">¶</a></h2>
<p>This helper is loaded using the following code:</p>
<div class="highlight-ci"><div class="highlight"><pre><span class="nv">$this</span><span class="o">-></span><span class="na">load</span><span class="o">-></span><span class="na">helper</span><span class="p">(</span><span class="s1">'download'</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="available-functions">
<h2><a class="toc-backref" href="#id2">Available Functions</a><a class="headerlink" href="#available-functions" title="Permalink to this headline">¶</a></h2>
<p>The following functions are available:</p>
<dl class="function">
<dt id="force_download">
<tt class="descname">force_download</tt><big>(</big><span class="optional">[</span><em>$filename = ''</em><span class="optional">[</span>, <em>$data = ''</em><span class="optional">[</span>, <em>$set_mime = FALSE</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#force_download" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>$filename</strong> (<em>string</em>) – Filename</li>
<li><strong>$data</strong> (<em>mixed</em>) – File contents</li>
<li><strong>$set_mime</strong> (<em>bool</em>) – Whether to try to send the actual MIME type</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
</td>
</tr>
</tbody>
</table>
<p>Generates server headers which force data to be downloaded to your
desktop. Useful with file downloads. The first parameter is the <strong>name
you want the downloaded file to be named</strong>, the second parameter is the
file data.</p>
<p>If you set the second parameter to NULL and <tt class="docutils literal"><span class="pre">$filename</span></tt> is an existing, readable
file path, then its content will be read instead.</p>
<p>If you set the third parameter to boolean TRUE, then the actual file MIME type
(based on the filename extension) will be sent, so that if your browser has a
handler for that type - it can use it.</p>
<p>Example:</p>
<div class="highlight-ci"><div class="highlight"><pre><span class="nv">$data</span> <span class="o">=</span> <span class="s1">'Here is some text!'</span><span class="p">;</span>
<span class="nv">$name</span> <span class="o">=</span> <span class="s1">'mytext.txt'</span><span class="p">;</span>
<span class="nx">force_download</span><span class="p">(</span><span class="nv">$name</span><span class="p">,</span> <span class="nv">$data</span><span class="p">);</span>
</pre></div>
</div>
<p>If you want to download an existing file from your server you’ll need to
do the following:</p>
<div class="highlight-ci"><div class="highlight"><pre><span class="c1">// Contents of photo.jpg will be automatically read</span>
<span class="nx">force_download</span><span class="p">(</span><span class="s1">'/path/to/photo.jpg'</span><span class="p">,</span> <span class="k">NULL</span><span class="p">);</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="email_helper.html" class="btn btn-neutral float-right" title="Email Helper">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="directory_helper.html" class="btn btn-neutral" title="Directory Helper"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014 - 2016, British Columbia Institute of Technology.
Last updated on Jan 13, 2016.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '3.0.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: false
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html> |
<!DOCTYPE html>
<html xmlns:mso="urn:schemas-microsoft-com:office:office" xmlns:msdt="uuid:C2F41010-65B3-11d1-A29F-00AA00C14882">
<head>
<meta charset="UTF-8">
<style>
::selection {
background: #b7ffb7;
}
::-moz-selection {
background: #b7ffb7;
}
body {
font-family: Arial, Helvetica, sans-serif;
font-size: 16px;
width: 800px;
margin: 0 auto;
}
#banner {
/* Div for banner */
float:left;
margin: 0px;
margin-bottom: 10px;
width: 100%;
background-color: #0071C5;
z-index: 0;
}
#banner .logo {
/* Apply to logo in banner. Add as class to image tag. */
float: left;
margin-right: 20px;
margin-left: 20px;
margin-top: 15px;
padding-bottom: 5px;
}
h1 {
text-align: center;
font-size: 36px;
}
h1.title {
/* Add as class to H1 in banner */
font-family: "Intel Clear", Verdana, Arial, sans-serif;
font-weight:normal;
color: #FFFFFF;
font-size: 170%;
margin-right: 40px;
margin-left: 40px;
padding-right: 20px;
text-indent: 20px;
}
.h3-alike {
display:inline;
font-size: 1.17em;
font-weight: bold;
color: #0071C5;
}
h3 {
font-size: 1.17em;
font-weight: bold;
color: #0071C5;
}
.h4-alike {
display:inline;
font-size: 1.05em;
font-weight: bold;
}
pre {
font-family: "Consolas", Monaco, monospace;
font-size:small;
background: #fafafa;
margin: 0;
padding-left:20px;
}
#footer {
font-size: small;
}
code {
font-family: "Consolas", Monaco, monospace;
}
.code-block
{
padding-left:20px;
}
.changes {
margin: 1em 0;
}
.changes input:active {
position: relative;
top: 1px;
}
.changes input:hover:after {
padding-left: 16px;
font-size: 10px;
content: 'More';
}
.changes input:checked:hover:after {
content: 'Less';
}
.changes input + .show-hide {
display: none;
}
.changes input:checked + .show-hide {
display: block;
}
ul {
margin: 0;
padding: 0.5em 0 0.5em 2.5em;
}
ul li {
margin-bottom: 3px;
}
ul li:last-child {
margin-bottom: 0;
}
.disc {
list-style-type:disc
}
.circ {
list-style-type:circle
}
.single {
padding: 0 0.5em;
}
/* ------------------------------------------------- */
/* Table styles */
table{
margin-bottom:5pt;
border-collapse:collapse;
margin-left:0px;
margin-top:0.3em;
font-size:10pt;
}
tr{
vertical-align:top;
}
th,
th h3{
padding:4px;
text-align:left;
background-color:#0071C5;
font-weight:bold;
margin-top:1px;
margin-bottom:0;
color:#FFFFFF;
font-size:10pt;
vertical-align:middle;
}
th{
border:1px #dddddd solid;
padding-top:2px;
padding-bottom:0px;
padding-right:3px;
padding-left:3px;
}
td{
border:1px #dddddd solid;
vertical-align:top;
font-size:100%;
text-align:left;
margin-bottom:0;
}
td,
td p{
margin-top:0;
margin-left:0;
text-align:left;
font-size:inherit;
line-height:120%;
}
td p{
margin-bottom:0;
padding-top:5px;
padding-bottom:5px;
padding-right:5px;
padding-left:1px;
}
.noborder{
border:0px none;
}
.noborder1stcol{
border:0px none;
padding-left:0pt;
}
td ol{
font-size:inherit;
margin-left:28px;
}
td ul{
font-size:inherit;
margin-left:24px;
}
.DefListTbl{
width:90%;
margin-left:-3pt;
}
.syntaxdiagramtbl{
margin-left:-3pt;
}
.sdtbl{
}
.sdrow{
}
.sdtblp{
border:0px none;
font-size:inherit;
line-height:120%;
margin-bottom:0;
padding-bottom:0px;
padding-top:5px;
padding-left:0px;
padding-right:5px;
vertical-align:top;
}
.idepara, .ide_para{
border:0px none;
font-size:inherit;
line-height:120%;
margin-bottom:0;
padding-bottom:0px;
padding-top:5px;
padding-left:0px;
padding-right:5px;
vertical-align:top;
}
.specs {
border-collapse:collapse;
}
.specs td, .specs th {
font-size: 14px;
}
.specs td {
border: 1px solid black;
}
.specs td td, .specs td th {
border: none;
}
.specs td, .specs td td, .specs td th {
padding: 0 0.2em 0.2em;
text-align: center;
}
.specs td tr:last-child td,
.specs td tr:last-child th {
padding: 0 0.2em;
}
.serial-time {
}
.modified-time {
width: 6.5em;
}
.compiler {
}
.comp-opt {
}
.sys-specs {
width: 18em;
}
.note {
font-size:small;
font-style: italic;
}
</style>
<title>Intel® Threading Building Blocks. Getting Started Samples</title>
</head>
<body>
<div id="banner">
<img class="logo" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEMAAAAsCAYAAAA+aAX8AAAAAXNSR0IArs4c6QAAAARnQU1BAACx
jwv8YQUAAAAJcEhZcwAALiIAAC4iAari3ZIAAAAZdEVYdFNvZnR3YXJlAEFkb2JlIEltYWdlUmVh
ZHlxyWU8AAAIN0lEQVRoQ+WaCaxdUxSGW2ouatZWaVS15nkqkZhSVERQglLEPCam1BCixhqqCKUS
NIiYpxhqHmouIeaY5ylFzA/v1fev8+/j3N5737v3vtf3buNP/uy9/7X2Ovuse4a997m9mgltbW2L
wRHwcHgFfAx+AH+GCb/BT2fNmvUk5ZXwYOrrOsTcCU5CJ74pPBJeA5+Bn8LfOLmagf/f8Af4NrwD
ngg3wdTHh2pOMMB1Gejx8AE4M85mNqD/A7+D78GXkXQFTIMPwUfhdPg6/AxWTRw29b8QruPD9zwY
zPrwHPi2xxmg3QrfgDfD05BGU24EB1HvC3s7REXgtwDsDzeEY+Ak+AJsUfwE2sJdcBN37V4whiU4
+KGUM2JEBtpzUInZEa5g9y4FcYfAo+GLPmwOND2HFrXrnAUHWgnq0vzDB2+Bt0H9coPs1m3gmNvD
ZyITBu234Jp26XoQfCC80sfTAXVv7wOXskuPgnHoSvnTw9P49MDdyOauAQEXhWdC4Vd4ARxmc1OB
cW0Gv3U+lJDvKFa0ufMg4GXwR3gs7J57sRNoaWnR2+znLB2RkKds6jwItvbckIQiGO+eTkSby71t
qh100qtsUCJxmmpSw5i2gWebR1jWm2047T1gf0vyfViJEKi/TtHua7wMdNJs8U/zDzjUpqYA47k4
O704wY+kUZ2P+glQc5ldac9j323sF1cH2EB6h8BxYZdbRDeDOJ16UBJiHDFuMMdYbhjEGA8DxJ4h
jXIemmMpz6ccqbZ1JUlT/3SrHC+9XeB0MjzV9RHqKFAXVg2nBkH/lxxO8aZYbhjEKEuGQH1BuCKc
z1IAN61jAtiut1wZ+ByIkwa6r9t6ZmhSFZw9eL0gxiMw4SLLDYMYFZNRDbhpcpgwzXI5MOqSEvKM
Ue8D+xU4r/Xe+C8HB1ThkhFgNqAXk6FVqyZuA1LcItBXQd+WUvf6YMslwFZvMs7KvMP/SculwKa3
hfYPPsZpfsvS9QD9PRHbcOmUC9J+H2qfoRJ/0MHgFhHIQC8mQ8twxZ0Ji099vSGegn/TP0BdD/Db
Ycn0nna9yZiceQcetFwKDE/4oNtZCtDeXHoC7dWlU1Uyvs7U6sBHJ7FaBAPU82TYJUAzFnCU+1mq
COyfwGLi6k3G05l34BrL/wFxjA/0mKUcaNqBKiJODHclQ3sLCVqZprfEvVCLtThhiskRDFAvXhnv
QPlfi5uW7ytTL14Nr0Bd1pfDXy1Lv93h6koGLstCLR/SuPJ5SQBBD8hPZATbWs6BrdZk7B4dDNpT
Mjkw3bL0YjLOsxygPUWDyExtD1GNV6JAeyTUBlDCKtbrScYxhfjyj1s+B9o+dnifIj94AnpNyaC9
f3QwkNJCTnjOsvRiMi6xrHiaA3ycyYFNbcqBpisl/aoHWaspGdg03uIc43mb/gOilt3CREslQG80
GedmlkC1KyNPBnU9wOPWMp6Aut0S74HfwIQJ7ldTMjBPdBIiGWC0TRkQlseWNmR2tlwC9DmZjEmW
pQ/zOAKqtwdcrnW/DpOBPtp9Ii6F9lhL1yWIo2zUvVhxzYHeLVcG/QfT/iuTA3qwan+zGndVP8p2
k4G8E/wLW4D6PxTlnxgwaDEjaMe6n+USYOvqZKTbUrjQcor3ZSYHRtjULvCrmgwkfY5oRc9B+3Cb
S4FhIhS+gAtZLgH9Y6GWuQU6mwx9IEqYajlA+47CsZ6lGovFBDTNkA9xM4CmpXsAWySDUrPjqZQl
QBsfnSoB41UKAvS9ouJmDfpaDpTQ2WRcXYinCZm+pdyEtDClPgLloP0unABPp3lrpoZ+KkWskSgP
sVZMhlat2t7LQftE2aoCh0sVBOheXclyCYjTp7W19bUsZAQtJuPLTA39gOhg0D7PJtny1xj1tWA+
sUpAG2j7mZaqAh9tzPSVP+XStL+w/qY1XRlfWdOSYXvp7QKnU6Ayqk4jLZcB2zD4gv1iu52qkvG5
NKPsyrCuPs9aDtDeDr4EtS7RRyXNCgfYLPtYfoC33D0Hul6tE6jOfvsMhVqaT8PWG85PXR+WxlOP
pHUIHPNXDsif7NWAT773STdlX6vK4ebi4WRgWybZqFe86tBXUAw4BL+S7UTautTXo9yFcjdKPbsq
PuQTsKdbZ16YLzZrAgdRRvXLCF/Big/R/wXInn5dffdMt8opNs214Bz6cyqNbUDRcZwTIWjDt3m+
XtcBxq3pvL6p6mFftlFUE+i8JPxRCRGoawVbcVepGcF4V4eTGPNPHv+7NjUGAhzmQOl20fyhphlg
T4CxLcQw9WC9Gxb3P4Q37NY4CHJXCuhSW3JnwEXs0qNgSHqVbw210ZP2XwK0A65/6C6NgziaAU5X
wCIUHB4H86227gKH1+JtL3gd1N5sCdACbgZo5rtgnQKx+hLs/ixsdjBXBd2TtyKNhUOp1/dprgMQ
rx9x16fcn1KbttrIyf9OkICWw1KApvY2YyXbpSBobKf7OGXApFtI+5d3Qq1BDoL6V87GcDVc9Ivq
E4D+bjTQbc1i9demreDu8Ch0ffG6hdnmDMrvFbsSsAXczIGk3fwb4VYe+pwBB9Angkd83ADtqgkq
AjetdTTV1icDlfl+Qi3AP4elHEjaDXscHgFjPdNt4ID6S9B9sNLiKoelmuFuJbCpDJi+hvqz2qFw
iIfWc2AQusxPgvq484vH2eUgtpYHH0Hteeqb75ZwMQ+j+cDg9PlwFDwd6o9sr0KtbWI/tSPgp32M
76H+s6mNX3030df5neGq1OtbZDUbOIlFoFaha0L9j0qfCHeAerDqVtODU8+hNThZfR1fHHbpG6kx
9Or1LzUmVVz+HJXDAAAAAElFTkSuQmCC">
<h1 class="title">Intel® Threading Building Blocks.<br>Getting Started Samples</h1>
</div>
<p>
This directory contains the examples referenced by the Intel® Threading Building Blocks <a href="http://software.intel.com/en-us/tbb-tutorial">Getting Started Guide</a>.
</p>
<div class="changes">
<div class="h3-alike">Directories</div>
<input type="checkbox" checked="checked">
<div class="show-hide">
<dl>
<dt><a href="sub_string_finder/readme.html">sub_string_finder</a>
<dd>Finds largest matching substrings.
</dl>
</div>
</div>
<br>
<a href="../index.html">Up to parent directory</a>
<hr>
<div class="changes">
<div class="h3-alike">Legal Information:</div>
<input type="checkbox">
<div class="show-hide">
<p>
Intel and the Intel logo are trademarks of Intel Corporation in the U.S. and/or other countries.
<br>* Other names and brands may be claimed as the property of others.
<br>© 2016, Intel Corporation
</p>
</div>
</div>
</body>
</html>
|
<body>
This is the root of the JAIN implementation of SIP. It contains an
implementation of the Provider, Listener and Stack. Implementation of the
headers is contained in header and implementation of the parser in the
parser subdirectory. The SIP Protocol specific abstractions are implemented
in the stack subdirectory.
<p>
The RI contains several additional Features that are not required by the JAIN-SIP spec
and that can be enabled by RI-specific properties that are specified when the SipStack
is created. The purpose of these additional properties is to enable the following:
<ul>
<li> Message Logging features - permits the application to log messages in
a format that are suitable for trace viewing using the trace viewer facility.
<li> TCP starvation attack prevention - Limit the size and timeout for
tcp connections.
<li> UDP Flooding attack prevention -- limit the size of queues and transaction
table size.
<li> TCP message size limitation -- limit the size of TCP messages to prevent
TCP flooding attacks.
<li> Connection caching and reuse for TCP connections -- reduce latency by re-using
TCP connections on client and server transactions.
<li> Address resolution -- resolve addresses that are not direct DNS lookups or IP addresses
using a custom address resolver.
<li> Network Layer -- allows your application code to have direct access to the
Sockets that are used by the stack (use this feature with caution!).
</li>
</ul>
See the javadoc for gov.nist.javax.sip.SipStackImpl for a detailed explanation of
these features.
<p>
The interfaces that are suffixed with Ext in this package will not be altered and will
be included in the next specification revision. These are provided here for those who
wish to use these extensions and do not want to wait until the next spec revision
becomes available.
</body>
</a>
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>RSheet.SetOnSelectRow</title>
<link href="css/style.css" rel="stylesheet" type="text/css">
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%" bgcolor="#F0F0FF">
<tr>
<td>Concept Framework 2.2 documentation</td>
<td align="right"><a href="index.html">Contents</a> | <a href="index_fun.html">Index</a></td>
</tr>
</table>
<h2><a href="RSheet.html">RSheet</a>.SetOnSelectRow</h2>
<table border="0" cellspacing="0" cellpadding="0" width="500" style="border-style:solid;border-width:1px;border-color:#D0D0D0;">
<tr bgcolor="#f0f0f0">
<td><i>Name</i></td>
<td><i>Type</i></td>
<td><i>Access</i></td>
<td><i>Version</i></td>
<td><i>Deprecated</i></td>
</tr>
<tr bgcolor="#fafafa">
<td><b>SetOnSelectRow</b></td>
<td>function</td>
<td>public</td>
<td>version 1</td>
<td>no</td>
</tr>
</table>
<br />
<b>Prototype:</b><br />
<table bgcolor="#F0F0F0" width="100%" style="border-style:solid;border-width:1px;border-color:#D0D0D0;"><tr><td><b>public function SetOnSelectRow(var delegate deleg)</b></td></tr></table>
<br />
<b>Parameters:</b><br />
<table bgcolor="#FFFFFF" style="border-style:solid;border-width:1px;border-color:#D0D0D0;">
<tr>
<td>
<i>var</i>
</td>
<td>
// TO DO
</td>
</tr>
</table>
<br />
<b>Description:</b><br />
<table width="100%" bgcolor="#FAFAFF" style="border-style:solid;border-width:1px;border-color:#D0D0D0;">
<tr><td>
TODO: Document this
</td></tr>
</table>
<br />
<b>Returns:</b><br />
// TO DO
<br />
<br />
<!--
<p>
<a href="http://validator.w3.org/check?uri=referer"><img
src="http://www.w3.org/Icons/valid-html40"
alt="Valid HTML 4.0 Transitional" height="31" width="88" border="0"></a>
<a href="http://jigsaw.w3.org/css-validator/">
<img style="border:0;width:88px;height:31px"
src="http://jigsaw.w3.org/css-validator/images/vcss"
alt="Valid CSS!" border="0"/>
</a>
</p>
-->
<table bgcolor="#F0F0F0" width="100%"><tr><td>Documented by Devronium Autodocumenter Alpha, generation time: Sun Jan 27 18:15:31 2013
GMT</td><td align="right">(c)2013 <a href="http://www.devronium.com">Devronium Applications</a></td></tr></table>
</body>
</html> |
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>DemoScript3DOrbit Constructor </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="DemoScript3DOrbit class, constructor" /><meta name="System.Keywords" content="DemoScript3DOrbit.DemoScript3DOrbit constructor" /><meta name="Microsoft.Help.F1" content="DigitalRubyShared.DemoScript3DOrbit.#ctor" /><meta name="Microsoft.Help.F1" content="DigitalRubyShared.DemoScript3DOrbit.DemoScript3DOrbit" /><meta name="Microsoft.Help.Id" content="M:DigitalRubyShared.DemoScript3DOrbit.#ctor" /><meta name="Description" content="DigitalRubyShared.DemoScript3DOrbit" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="DigitalRubyShared" /><meta name="file" content="af599724-5dc4-e839-3bf5-307c4bb67d93" /><meta name="guid" content="af599724-5dc4-e839-3bf5-307c4bb67d93" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-3.3.1.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">Fingers - Gestures for Unity Code Documentation<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/266b9e60-57a0-7428-2a0d-8e829ed21058.htm" title="Fingers - Gestures for Unity Code Documentation" tocid="roottoc">Fingers - Gestures for Unity Code Documentation</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/266b9e60-57a0-7428-2a0d-8e829ed21058.htm" title="DigitalRubyShared" tocid="266b9e60-57a0-7428-2a0d-8e829ed21058">DigitalRubyShared</a></div><div class="toclevel1" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/3397dcb8-69b6-ea17-5cf9-14f64d91a884.htm" title="DemoScript3DOrbit Class" tocid="3397dcb8-69b6-ea17-5cf9-14f64d91a884">DemoScript3DOrbit Class</a></div><div class="toclevel2 current" data-toclevel="2"><a data-tochassubtree="false" href="../html/af599724-5dc4-e839-3bf5-307c4bb67d93.htm" title="DemoScript3DOrbit Constructor " tocid="af599724-5dc4-e839-3bf5-307c4bb67d93">DemoScript3DOrbit Constructor </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/a5509d04-dd3e-aae0-2d4c-5d20adb581c0.htm" title="DemoScript3DOrbit Properties" tocid="a5509d04-dd3e-aae0-2d4c-5d20adb581c0">DemoScript3DOrbit Properties</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/82fffe55-5462-09fd-1e90-2b766f9cd5b3.htm" title="DemoScript3DOrbit Methods" tocid="82fffe55-5462-09fd-1e90-2b766f9cd5b3">DemoScript3DOrbit Methods</a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn"><h1>DemoScript3DOrbit Constructor </h1></td></tr></table><span class="introStyle"></span> <div class="summary">Initializes a new instance of the <a href="3397dcb8-69b6-ea17-5cf9-14f64d91a884.htm">DemoScript3DOrbit</a> class</div><p> </p>
<strong>Namespace:</strong>
<a href="266b9e60-57a0-7428-2a0d-8e829ed21058.htm">DigitalRubyShared</a><br />
<strong>Assembly:</strong>
Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID1RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID0EACA_tab1" class="codeSnippetContainerTabSingle">C#</div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EACA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID0EACA');return false;" title="Copy">Copy</a></div></div><div id="ID0EACA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="identifier">DemoScript3DOrbit</span>()</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EACA");</script></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID2RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="3397dcb8-69b6-ea17-5cf9-14f64d91a884.htm">DemoScript3DOrbit Class</a></div><div class="seeAlsoStyle"><a href="266b9e60-57a0-7428-2a0d-8e829ed21058.htm">DigitalRubyShared Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"><p>(c) 2015 to present, Digital Ruby, LLC</p><div class="feedbackLink">Send comments on this topic to
<a id="HT_MailLink" href="mailto:support%40digitalruby.com?Subject=Fingers%20-%20Gestures%20for%20Unity%20Code%20Documentation">support@digitalruby.com</a></div>
<script type="text/javascript">
var HT_mailLink = document.getElementById("HT_MailLink");
var HT_mailLinkText = HT_mailLink.innerHTML;
HT_mailLink.href += ": " + document.title + "\u0026body=" + encodeURIComponent("Your feedback is used to improve the documentation and the product. Your e-mail address will not be used for any other purpose and is disposed of after the issue you report is resolved. While working to resolve the issue that you report, you may be contacted via e-mail to get further details or clarification on the feedback you sent. After the issue you report has been addressed, you may receive an e-mail to let you know that your feedback has been addressed.");
HT_mailLink.innerHTML = HT_mailLinkText;
</script> </div></body></html> |
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<link
rel="apple-touch-icon"
sizes="76x76"
href="https://demos.creative-tim.com/argon-design-system-pro/assets/img/apple-icon.png"
/>
<link
rel="icon"
href="https://demos.creative-tim.com/argon-design-system-pro/assets/img/apple-icon.png"
type="image/png"
/>
<meta
name="viewport"
content="width=device-width, initial-scale=1, shrink-to-fit=no"
/>
<meta name="author" content="Creative Tim" />
<title>Overview | Soft UI Dashboard Bootstrap @ Creative Tim</title>
<link
rel="canonical"
href="https://www.creative-tim.com/learning-lab/bootstrap/overview/soft-ui-dashboard"
/>
<meta name="keywords" content="creative tim, updivision, html dashboard, laravel, livewire, laravel livewire, alpine.js, html css dashboard laravel, soft ui dashboard laravel, livewire soft ui dashboard, soft ui admin, livewire dashboard, livewire admin, web dashboard, bootstrap 4 dashboard laravel, bootstrap 4, css3 dashboard, bootstrap 4 admin laravel, soft ui dashboard bootstrap 4 laravel, frontend, responsive bootstrap 4 dashboard, soft ui dashboard, soft ui laravel bootstrap 4 dashboard" />
<meta name="description" content="Dozens of handcrafted UI components, Laravel authentication, register & profile editing, Livewire & Alpine.js" />
<meta itemprop="name" content="Soft UI Dashboard Laravel by Creative Tim & UPDIVISION" />
<meta itemprop="description" content="Dozens of handcrafted UI components, Laravel authentication, register & profile editing, Livewire & Alpine.js" />
<meta itemprop="image" content="https://s3.amazonaws.com/creativetim_bucket/products/492/original/opt_sd_laravel_thumbnail.jpg" />
<meta name="twitter:card" content="product" />
<meta name="twitter:site" content="@creativetim" />
<meta name="twitter:title" content="Soft UI Dashboard Laravel by Creative Tim & UPDIVISION" />
<meta name="twitter:description" content="Dozens of handcrafted UI components, Laravel authentication, register & profile editing, Livewire & Alpine.js" />
<meta name="twitter:creator" content="@creativetim" />
<meta name="twitter:image" content="https://s3.amazonaws.com/creativetim_bucket/products/492/original/opt_sd_laravel_thumbnail.jpg" />
<meta property="fb:app_id" content="655968634437471" />
<meta property="og:title" content="Soft UI Dashboard Laravel by Creative Tim & UPDIVISION" />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://www.creative-tim.com/live/vue-argon-dashboard-laravel" />
<meta property="og:image" content="https://s3.amazonaws.com/creativetim_bucket/products/492/original/opt_sd_laravel_thumbnail.jpg" />
<meta property="og:description" content="Dozens of handcrafted UI components, Laravel authentication, register & profile editing, Livewire & Alpine.js" />
<meta property="og:site_name" content="Creative Tim" />
<script>
(function(a,s,y,n,c,h,i,d,e){
s.className+=' '+y;
h.start=1*new Date;
h.end=i=function(){
s.className=s.className.replace(RegExp(' ?'+y),'')
};
(a[n]=a[n]||[]).hide=h;
setTimeout(function(){i();h.end=null},c);
h.timeout=c;
})(window,document.documentElement,'async-hide','dataLayer',4000,
{'GTM-K9BGS8K':true});
</script>
<script>
(function(i,s,o,g,r,a,m){
i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();
a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;
m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-46172202-22', 'auto', {allowLinker: true});
ga('set', 'anonymizeIp', true);
ga('require', 'GTM-K9BGS8K');
ga('require', 'displayfeatures');
ga('require', 'linker');
ga('linker:autoLink', ["2checkout.com","avangate.com"]);
</script>
<script>
(function(w,d,s,l,i)
{w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});
var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';
j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-NKDMSK6');
</script>
<link
rel="stylesheet"
href="https://demos.creative-tim.com/argon-design-system-pro/assets/css/nucleo-icons.css"
type="text/css"
/>
<link href="" rel="stylesheet" />
<link
href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.0-beta1/dist/css/bootstrap.min.css"
rel="stylesheet"
integrity="sha384-giJF6kkoqNQ00vy+HMDP7azOuL0xtbfIcaT9wjKHr8RbDVddVHyTfAAsrekwKmP1"
crossorigin="anonymous"
/>
<link
rel="stylesheet"
href="https://demos.creative-tim.com/soft-ui-design-system-pro/assets/css/soft-design-system-pro.min.css?v=1.0.0"
type="text/css"
/>
<link rel="stylesheet" href="../../assets/demo.css" type="text/css" />
<link
href="https://fonts.googleapis.com/css?family=Open+Sans:300,400,600,700"
rel="stylesheet"
/>
<link
href="https://demos.creative-tim.com/argon-design-system-pro/assets/css/nucleo-icons.css"
rel="stylesheet"
/>
<script
src="https://kit.fontawesome.com/42d5adcbca.js"
crossorigin="anonymous"
></script>
<!-- Anti-flicker snippet (recommended) -->
<style>
.async-hide {
opacity: 0 !important;
}
</style>
<link
href="https://fonts.googleapis.com/css?family=Open+Sans:300,400,600,700"
rel="stylesheet"
/>
<link href="../../../assets/docs-soft.css" rel="stylesheet" />
</head>
<body class="docs">
<!-- Google Tag Manager (noscript) -->
<noscript
><iframe
src="https://www.googletagmanager.com/ns.html?id=GTM-NKDMSK6"
height="0"
width="0"
style="display: none; visibility: hidden"
></iframe
></noscript>
<!-- End Google Tag Manager (noscript) -->
<header class="ct-docs-navbar">
<a
class="ct-docs-navbar-brand"
href="javascript:void(0)"
aria-label="Bootstrap"
>
<a
href="https://www.creative-tim.com/"
class="ct-docs-navbar-text"
target="_blank"
>
Creative Tim
</a>
<div class="ct-docs-navbar-border"></div>
<a
href="../../overview/soft-ui-dashboard/index.html"
class="ct-docs-navbar-text"
>
Docs
</a>
</a>
<ul class="ct-docs-navbar-nav-left">
<li class="ct-docs-nav-item-dropdown">
<a
href="javascript:;"
class="ct-docs-navbar-nav-link"
role="button"
>
<span class="ct-docs-navbar-nav-link-inner--text"
>Live Preview</span
>
</a>
<div
class="ct-docs-navbar-dropdown-menu"
aria-labelledby="DropdownPreview"
>
<a
class="ct-docs-navbar-dropdown-item"
href="https://soft-ui-dashboard-laravel.creative-tim.com/"
target="_blank"
>
Soft UI Dashboard
</a>
</div>
</li>
<li class="ct-docs-nav-item-dropdown">
<a
href="javascript:;"
class="ct-docs-navbar-nav-link"
role="button"
>
<span class="ct-docs-navbar-nav-link-inner--text"
>Support</span
>
</a>
<div
class="ct-docs-navbar-dropdown-menu"
aria-labelledby="DropdownSupport"
>
<a
class="ct-docs-navbar-dropdown-item"
href="https://github.com/creativetimofficial/soft-ui-dashboard-laravel/issues"
target="_blank"
>
Soft UI Dashboard
</a>
</div>
</li>
</ul>
<ul class="ct-docs-navbar-nav-right">
<li class="ct-docs-navbar-nav-item">
<a
class="ct-docs-navbar-nav-link"
href="https://www.creative-tim.com/product/soft-ui-dashboard-pro-laravel"
target="_blank"
>Buy Now</a
>
</li>
<li class="ct-docs-navbar-nav-item">
<a
class="ct-docs-navbar-nav-link"
href="https://www.creative-tim.com/product/soft-ui-dashboard-laravel"
target="_blank"
>Download Free</a
>
</li>
</ul>
<button class="ct-docs-navbar-toggler" type="button">
<span class="ct-docs-navbar-toggler-icon"></span>
</button>
</header>
<div class="ct-docs-main-container">
<div class="ct-docs-main-content-row">
<div class="ct-docs-sidebar-col">
<nav class="ct-docs-sidebar-collapse-links">
<div class="ct-docs-sidebar-product">
<div class="ct-docs-sidebar-product-image">
<img
src="../../../assets/images/bootstrap-5.svg"
/>
</div>
<p class="ct-docs-sidebar-product-text">
Soft UI Dashboard
</p>
</div>
<div class="ct-docs-toc-item-active">
<a
class="ct-docs-toc-link"
href="javascript:void(0)"
>
<div class="d-inline-block">
<div
class="
icon icon-xs
border-radius-md
bg-gradient-warning
text-center
mr-2
d-flex
align-items-center
justify-content-center
me-1
"
>
<i
class="ni ni-active-40 text-white"
></i>
</div>
</div>
Getting started
</a>
<ul class="ct-docs-nav-sidenav ms-4 ps-1">
<li class="ct-docs-nav-sidenav-active">
<a
href="../../../bootstrap/overview/soft-ui-dashboard/index.html"
>
Overview
</a>
</li>
<li class="">
<a
href="../../../bootstrap/license/soft-ui-dashboard/index.html"
>
License
</a>
</li>
<li class="">
<a
href="../../../bootstrap/installation/soft-ui-dashboard/index.html"
>
Installation
</a>
</li>
<li class="">
<a
href="../../../bootstrap/build-tools/soft-ui-dashboard/index.html"
>
Build Tools
</a>
</li>
<li class="">
<a
href="../../../bootstrap/what-is-bootstrap/soft-ui-dashboard/index.html"
>
What is Bootstrap
</a>
</li>
</ul>
</div>
<div class="ct-docs-toc-item-active">
<a
class="ct-docs-toc-link"
href="javascript:void(0)"
>
<div class="d-inline-block">
<div
class="
icon icon-xs
border-radius-md
bg-gradient-warning
text-center
mr-2
d-flex
align-items-center
justify-content-center
me-1
"
>
<i
class="ni ni-folder-17 text-white"
></i>
</div>
</div>
Laravel
</a>
<ul class="ct-docs-nav-sidenav ms-4 ps-1">
<li class="">
<a
href="../../../bootstrap/login/soft-ui-dashboard/index.html"
>
Login
</a>
</li>
<li class="">
<a
href="../../../bootstrap/sign-up/soft-ui-dashboard/index.html"
>
Sign Up
</a>
</li>
<li class="">
<a
href="../../../bootstrap/forgot-password/soft-ui-dashboard/index.html"
>
Forgot Password
</a>
</li>
<li class="">
<a
href="../../../bootstrap/reset-password/soft-ui-dashboard/index.html"
>
Reset Password
</a>
</li>
<li class="">
<a
href="../../../bootstrap/profile/soft-ui-dashboard/index.html"
>
User Profile
</a>
</li>
</ul>
</div>
<div class="ct-docs-toc-item-active">
<a
class="ct-docs-toc-link"
href="javascript:void(0)"
>
<div class="d-inline-block">
<div
class="
icon icon-xs
border-radius-md
bg-gradient-warning
text-center
mr-2
d-flex
align-items-center
justify-content-center
me-1
"
>
<i
class="ni ni-folder-17 text-white"
></i>
</div>
</div>
Foundation
</a>
<ul class="ct-docs-nav-sidenav ms-4 ps-1">
<li class="">
<a
href="../../../bootstrap/colors/soft-ui-dashboard/index.html"
>
Colors
</a>
</li>
<li class="">
<a
href="../../../bootstrap/grid/soft-ui-dashboard/index.html"
>
Grid
</a>
</li>
<li class="">
<a
href="../../../bootstrap/typography/soft-ui-dashboard/index.html"
>
Typography
</a>
</li>
<li class="">
<a
href="../../../bootstrap/icons/soft-ui-dashboard/index.html"
>
Icons
</a>
</li>
<li class="">
<a
href="../../../bootstrap/utilities/soft-ui-dashboard/index.html"
>
Utilities
</a>
</li>
</ul>
</div>
<div class="ct-docs-toc-item-active">
<a
class="ct-docs-toc-link"
href="javascript:void(0)"
>
<div class="d-inline-block">
<div
class="
icon icon-xs
border-radius-md
bg-gradient-warning
text-center
mr-2
d-flex
align-items-center
justify-content-center
me-1
"
>
<i class="ni ni-app text-white"></i>
</div>
</div>
Components
</a>
<ul class="ct-docs-nav-sidenav ms-4 ps-1">
<li class="">
<a
href="../../../bootstrap/alerts/soft-ui-dashboard/index.html"
>
Alerts
</a>
</li>
<li class="">
<a
href="../../../bootstrap/badge/soft-ui-dashboard/index.html"
>
Badge
</a>
</li>
<li class="">
<a
href="../../../bootstrap/buttons/soft-ui-dashboard/index.html"
>
Buttons
</a>
</li>
<li class="">
<a
href="../../../bootstrap/social-buttons/soft-ui-dashboard/index.html"
>
Social Buttons
<span class="ct-docs-sidenav-pro-badge"
>Pro</span
>
</a>
</li>
<li class="">
<a
href="../../../bootstrap/cards/soft-ui-dashboard/index.html"
>
Cards
</a>
</li>
<li class="">
<a
href="../../../bootstrap/carousel/soft-ui-dashboard/index.html"
>
Carousel
</a>
</li>
<li class="">
<a
href="../../../bootstrap/collapse/soft-ui-dashboard/index.html"
>
Collapse
<span class="ct-docs-sidenav-pro-badge"
>Pro</span
>
</a>
</li>
<li class="">
<a
href="../../../bootstrap/dropdowns/soft-ui-dashboard/index.html"
>
Dropdowns
</a>
</li>
<li class="">
<a
href="../../../bootstrap/forms/soft-ui-dashboard/index.html"
>
Forms
</a>
</li>
<li class="">
<a
href="../../../bootstrap/input-group/soft-ui-dashboard/index.html"
>
Input Group
</a>
</li>
<li class="">
<a
href="../../../bootstrap/list-group/soft-ui-dashboard/index.html"
>
List Group
<span class="ct-docs-sidenav-pro-badge"
>Pro</span
>
</a>
</li>
<li class="">
<a
href="../../../bootstrap/modal/soft-ui-dashboard/index.html"
>
Modal
</a>
</li>
<li class="">
<a
href="../../../bootstrap/navs/soft-ui-dashboard/index.html"
>
Navs
</a>
</li>
<li class="">
<a
href="../../../bootstrap/navbar/soft-ui-dashboard/index.html"
>
Navbar
</a>
</li>
<li class="">
<a
href="../../../bootstrap/pagination/soft-ui-dashboard/index.html"
>
Pagination
</a>
</li>
<li class="">
<a
href="../../../bootstrap/popovers/soft-ui-dashboard/index.html"
>
Popovers
</a>
</li>
<li class="">
<a
href="../../../bootstrap/progress/soft-ui-dashboard/index.html"
>
Progress
</a>
</li>
<li class="">
<a
href="../../../bootstrap/tables/soft-ui-dashboard/index.html"
>
Tables
</a>
</li>
<li class="">
<a
href="../../../bootstrap/tooltips/soft-ui-dashboard/index.html"
>
Tooltips
</a>
</li>
</ul>
</div>
<div class="ct-docs-toc-item-active">
<a
class="ct-docs-toc-link"
href="javascript:void(0)"
>
<div class="d-inline-block">
<div
class="
icon icon-xs
border-radius-md
bg-gradient-warning
text-center
mr-2
d-flex
align-items-center
justify-content-center
me-1
"
>
<i
class="ni ni-settings text-white"
></i>
</div>
</div>
Plugins
</a>
<ul class="ct-docs-nav-sidenav ms-4 ps-1">
<li class="">
<a
href="../../../bootstrap/datepicker/soft-ui-dashboard/index.html"
>
Datepicker
<span class="ct-docs-sidenav-pro-badge"
>Pro</span
>
</a>
</li>
<li class="">
<a
href="../../../bootstrap/sliders/soft-ui-dashboard/index.html"
>
Sliders
<span class="ct-docs-sidenav-pro-badge"
>Pro</span
>
</a>
</li>
<li class="">
<a
href="../../../bootstrap/choices/soft-ui-dashboard/index.html"
>
Choices
<span class="ct-docs-sidenav-pro-badge"
>Pro</span
>
</a>
</li>
</ul>
</div>
</nav>
</div>
<div class="ct-docs-toc-col">
<ul class="section-nav">
<li class="toc-entry toc-h5">
<a href="#developer-first">Developer First</a>
</li>
<li class="toc-entry toc-h5">
<a href="#high-quality">High quality</a>
</li>
<li class="toc-entry toc-h5">
<a href="#community-helpers">Community helpers</a>
</li>
<li class="toc-entry toc-h3">
<a href="#resources-and-credits"
>Resources and credits</a
>
</li>
<li class="toc-entry toc-h3">
<a href="#learn-more">Learn more</a>
</li>
</ul>
</div>
<main class="ct-docs-content-col" role="main">
<div class="ct-docs-page-title">
<h1 class="ct-docs-page-h1-title" id="content">
Soft UI Dashboard Bootstrap
</h1>
<div class="avatar-group mt-3"></div>
</div>
<p class="ct-docs-page-title-lead">
An user-friendly, open source and beautiful dashboard
based on Bootstrap 5.
</p>
<hr class="ct-docs-hr" />
<p>
We at
<a href="https://www.creative-tim.com/" target="_blank"
>Creative Tim</a
>
have always wanted to deliver great tools to all the web
developers. We want to see better websites and web apps
on the internet.
</p>
<div class="row">
<div class="col-lg-4 col-md-6">
<div
class="
card
card-background
card-background-mask-warning
mt-md-0 mt-5
"
>
<div
class="full-background"
style="
background-image: url('https://demos.creative-tim.com/soft-ui-design-system-pro/assets/img/curved-images/curved8.jpg');
"
></div>
<div class="card-body pt-5 text-center">
<div class="icon mx-auto text-lg">
<i class="ni ni-html5"></i>
</div>
<h5 class="text-white mb-2">
Developer First
</h5>
<p>
Soft UI Dashboard is a "Developer First"
product, with a lot of variables for
colors, fonts, sizes and other elements.
</p>
</div>
</div>
</div>
<div class="col-lg-4 col-md-6">
<div
class="
card
card-background
card-background-mask-warning
mt-md-0 mt-5
"
>
<div
class="full-background"
style="
background-image: url('https://demos.creative-tim.com/soft-ui-design-system-pro/assets/img/curved-images/curved9.jpg');
"
></div>
<div class="card-body pt-5 text-center">
<div class="icon mx-auto text-lg">
<i class="ni ni-paper-diploma"></i>
</div>
<h5 class="text-white mb-2">
High quality
</h5>
<p>
We are following the latest code
standards provided by the guys from
Bootstrap, so you will love working with
this dashboard.
</p>
</div>
</div>
</div>
<div class="col-lg-4 col-md-6">
<div
class="
card
card-background
card-background-mask-warning
mt-md-0 mt-5
"
>
<div
class="full-background"
style="
background-image: url('https://demos.creative-tim.com/soft-ui-design-system-pro/assets/img/curved-images/curved6.jpg');
"
></div>
<div class="card-body pt-5 text-center">
<div class="icon mx-auto text-lg">
<i class="ni ni-favourite-28"></i>
</div>
<h5 class="text-white mb-2">
Community helpers
</h5>
<p>
Since all our products are built on top
of Open Source also Soft UI Dashboard is
released under
<a
class="
text-white
font-weight-bolder
"
href="https://github.com/creativetimofficial/softui-dashboard/blob/master/LICENSE.md"
target="_blank"
rel="nofollow"
>MIT License</a
>
</p>
</div>
</div>
</div>
</div>
<h3 id="resources-and-credits">Resources and credits</h3>
<p>
This Dashboard is fully coded and built on top of Open
Source, more details here:
</p>
<ul>
<li>
<a
href="https://www.getbootstrap.com"
rel="nofollow"
target="_blank"
>Bootstrap 5</a
>
- Open source front end framework
</li>
<li>
<a
href="https://refreshless.com/nouislider/"
rel="nofollow"
target="_blank"
>noUISlider</a
>
- JavaScript Range Slider
</li>
<li>
<a
href="https://popper.js.org/"
rel="nofollow"
target="_blank"
>Popper.js</a
>
- Kickass library used to manage poppers
</li>
<li>
<a
href="https://flatpickr.js.org/"
rel="nofollow"
target="_blank"
>Flatpickr</a
>
- Useful library used to select date
</li>
<li>
<a
href="https://joshuajohnson.co.uk/Choices/"
rel="nofollow"
target="_blank"
>Choices JS</a
>
- A nice plugin that select elements with intuitive
multiselection and searching but also for managing
tags.
</li>
<li>
<a
href="https://laravel.com/"
rel="nofollow"
target="_blank"
>Laravel</a
>
- Open source backend framework with robust
features, simple and secure authentication and
elegant syntax
</li>
<li>
<a
href="https://laravel-livewire.com/"
rel="nofollow"
target="_blank"
>Livewire</a
>
- Full-stack framework for Laravel
</li>
</ul>
<h3 id="learn-more">Learn more</h3>
<p>
Stay up to date on the development journey and connect
with us on:
</p>
<ul>
<li>
Follow
<a
href="https://twitter.com/creativetim"
rel="nofollow"
target="_blank"
>Creative Tim on Twitter</a
>.
</li>
<li>
Read and subscribe to
<a
href="https://creative-tim.com/blog"
rel="nofollow"
target="_blank"
>The Official Creative Tim Blog</a
>.
</li>
<li>
Follow
<a
href="https://www.instagram.com/creativetimofficial"
rel="nofollow"
target="_blank"
>Creative Tim on Instagram</a
>.
</li>
<li>
Follow
<a
href="https://www.facebook.com/creativetim"
rel="nofollow"
target="_blank"
>Creative Tim on Facebook</a
>.
</li>
</ul>
<h3 id="press-here-to-quick-start">
<a href="../quick-start/soft-ui-dashboard">UPDIVISION</a>
</h3>
<ul>
<li>
Follow
<a
href="https://twitter.com/updivision"
rel="nofollow"
target="_blank"
>UPDIVISION on Twitter</a
>
</li>
<li>
Read and subscribe to
<a
href=" https://updivision.com/blog/"
rel="nofollow"
target="_blank"
>The UPDIVISION Blog</a
>.
</li>
<li>
Follow
<a
href=" https://www.linkedin.com/company/updivision"
rel="nofollow"
target="_blank"
>Creative Tim on Linkedin</a
>.
</li>
<li>
Follow
<a
href="https://www.facebook.com/updivision"
rel="nofollow"
target="_blank"
>UPDIVISION on Facebook</a
>.
</li>
</ul>
</main>
</div>
<div class="ct-docs-main-footer-row">
<div class="ct-docs-main-footer-blank-col"></div>
<div class="ct-docs-main-footer-col">
<footer class="ct-docs-footer">
<div class="ct-docs-footer-inner-row">
<div class="ct-docs-footer-col">
<div class="ct-docs-footer-copyright">
©
<script>
document.write(
new Date().getFullYear()
);
</script>
<a
href="https://creative-tim.com"
class="ct-docs-footer-copyright-author"
target="_blank"
>Creative Tim</a
>
&
<a
href="https://updivision.com"
class="ct-docs-footer-copyright-author"
target="_blank"
>UPDIVISION</a
>
</div>
</div>
<div class="ct-docs-footer-col">
<ul class="ct-docs-footer-nav-footer">
<li>
<a
href="https://creative-tim.com"
class="ct-docs-footer-nav-link"
target="_blank"
>Creative Tim</a
>
</li>
<li>
<a
href="https://updivision.com"
class="ct-docs-footer-nav-link"
target="_blank"
>UPDIVISION</a
>
</li>
<li>
<a
href="https://www.creative-tim.com/contact-us"
class="ct-docs-footer-nav-link"
target="_blank"
>Contact Us</a
>
</li>
<li>
<a
href="https://creative-tim.com/blog"
class="ct-docs-footer-nav-link"
target="_blank"
>Blog</a
>
</li>
</ul>
</div>
</div>
</footer>
</div>
</div>
</div>
<script
src="https://demos.creative-tim.com/argon-dashboard-pro/assets/vendor/jquery/dist/jquery.min.js"
type="text/javascript"
></script>
<script
src="https://demos.creative-tim.com/soft-ui-design-system-pro/assets/js/core/popper.min.js"
type="text/javascript"
></script>
<script
src="https://demos.creative-tim.com/soft-ui-design-system-pro/assets/js/core/bootstrap.min.js"
type="text/javascript"
></script>
<script src="" type="text/javascript"></script>
<script src="" type="text/javascript"></script>
<script src="" type="text/javascript"></script>
<script src="" type="text/javascript"></script>
<script
src="https://demos.creative-tim.com/argon-dashboard-pro/assets/vendor/prismjs/prism.js"
type="text/javascript"
></script>
<script
src="https://demos.creative-tim.com/argon-design-system-pro/assets/demo/docs.min.js"
type="text/javascript"
></script>
<script
src="https://demos.creative-tim.com/argon-design-system-pro/assets/demo/vendor/holder.min.js"
type="text/javascript"
></script>
<script
src="https://demos.creative-tim.com/soft-ui-design-system-pro/assets/js/plugins/moment.min.js"
type="text/javascript"
></script>
<script
src="https://demos.creative-tim.com/soft-ui-design-system-pro/assets/js/soft-design-system-pro.min.js?v=1.0.0"
type="text/javascript"
></script>
<script>
Holder.addTheme("gray", {
bg: "#777",
fg: "rgba(255,255,255,.75)",
font: "Helvetica",
fontweight: "normal",
});
</script>
<script>
// Facebook Pixel Code Don't Delete
!(function (f, b, e, v, n, t, s) {
if (f.fbq) return;
n = f.fbq = function () {
n.callMethod
? n.callMethod.apply(n, arguments)
: n.queue.push(arguments);
};
if (!f._fbq) f._fbq = n;
n.push = n;
n.loaded = !0;
n.version = "2.0";
n.queue = [];
t = b.createElement(e);
t.async = !0;
t.src = v;
s = b.getElementsByTagName(e)[0];
s.parentNode.insertBefore(t, s);
})(
window,
document,
"script",
"//connect.facebook.net/en_US/fbevents.js"
);
try {
fbq("init", "111649226022273");
fbq("track", "PageView");
} catch (err) {
console.log("Facebook Track Error:", err);
}
</script>
<script src="../../../assets/docs.js"></script>
</body>
</html>
|
<html>
<head>
<meta charset="UTF-8">
<title>출력결과</title>
</head>
<body>
<script>
function solution(s) {
let answer = "";
let object = {};
for (let i = 0; i < s.length; i++) {
if (object[s[i]] != true) {
answer += s[i];
object[s[i]] = true;
}
}
return answer;
}
console.log(solution("ksekkset"));
</script>
</body>
</html> |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Code Coverage for D:\laragon\www\test-eliseev\vendor\codeception\lib-innerbrowser\src\Codeception\Exception</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="../../../../../_css/bootstrap.min.css" rel="stylesheet" type="text/css">
<link href="../../../../../_css/octicons.css" rel="stylesheet" type="text/css">
<link href="../../../../../_css/style.css" rel="stylesheet" type="text/css">
<link href="../../../../../_css/custom.css" rel="stylesheet" type="text/css">
</head>
<body>
<header>
<div class="container-fluid">
<div class="row">
<div class="col-md-12">
<nav aria-label="breadcrumb">
<ol class="breadcrumb">
<li class="breadcrumb-item"><a href="../../../../../index.html">D:\laragon\www\test-eliseev\vendor</a></li>
<li class="breadcrumb-item"><a href="../../../../index.html">codeception</a></li>
<li class="breadcrumb-item"><a href="../../../index.html">lib-innerbrowser</a></li>
<li class="breadcrumb-item"><a href="../../index.html">src</a></li>
<li class="breadcrumb-item"><a href="../index.html">Codeception</a></li>
<li class="breadcrumb-item active">Exception</li>
<li class="breadcrumb-item">(<a href="dashboard.html">Dashboard</a>)</li>
</ol>
</nav>
</div>
</div>
</div>
</header>
<div class="container-fluid">
<div class="table-responsive">
<table class="table table-bordered">
<thead>
<tr>
<td> </td>
<td colspan="9"><div align="center"><strong>Code Coverage</strong></div></td>
</tr>
<tr>
<td> </td>
<td colspan="3"><div align="center"><strong>Lines</strong></div></td>
<td colspan="3"><div align="center"><strong>Functions and Methods</strong></div></td>
<td colspan="3"><div align="center"><strong>Classes and Traits</strong></div></td>
</tr>
</thead>
<tbody>
<tr>
<td class="">Total</td>
<td class=" big"></td>
<td class=" small"><div align="right">n/a</div></td>
<td class=" small"><div align="right">0 / 0</div></td>
<td class=" big"></td>
<td class=" small"><div align="right">n/a</div></td>
<td class=" small"><div align="right">0 / 0</div></td>
<td class=" big"></td>
<td class=" small"><div align="right">n/a</div></td>
<td class=" small"><div align="right">0 / 0</div></td>
</tr>
<tr>
<td class=""><img src="../../../../../_icons/file-code.svg" class="octicon" /><a href="ExternalUrlException.php.html">ExternalUrlException.php</a></td>
<td class=" big"></td>
<td class=" small"><div align="right">n/a</div></td>
<td class=" small"><div align="right">0 / 0</div></td>
<td class=" big"></td>
<td class=" small"><div align="right">n/a</div></td>
<td class=" small"><div align="right">0 / 0</div></td>
<td class=" big"></td>
<td class=" small"><div align="right">n/a</div></td>
<td class=" small"><div align="right">0 / 0</div></td>
</tr>
</tbody>
</table>
</div>
<footer>
<hr/>
<h4>Legend</h4>
<p>
<span class="danger"><strong>Low</strong>: 0% to 50%</span>
<span class="warning"><strong>Medium</strong>: 50% to 90%</span>
<span class="success"><strong>High</strong>: 90% to 100%</span>
</p>
<p>
<small>Generated by <a href="https://github.com/sebastianbergmann/php-code-coverage" target="_top">php-code-coverage 7.0.10</a> using <a href="https://secure.php.net/" target="_top">PHP 7.2.11</a> with <a href="https://xdebug.org/">Xdebug 2.9.6</a> and <a href="https://phpunit.de/">PHPUnit 8.5.8</a> at Thu Jul 16 12:46:45 UTC 2020.</small>
</p>
</footer>
</div>
</body>
</html>
|
<!DOCTYPE html>
<html>
<head>
<title> Valorant </title>
<meta charset="UTF-8">
<link rel="stylesheet" href="/style.css">
</head>
<body>
<div id=backColor>
<div class=header>
<h1> Valorant </h1>
</div>
<p> A new free to play game whose beta is about to end, Valorant is my favourite game. Now, I dont mean to toot my own horn here
but let me just say, I am amazing at Valorant. With no hours put into CS:GO and about 10 hours put into paladins (a free to play ripoff of overwatch)
it should come as no surprise that I am Iron 1 at valorant with an impressive 1/10 Kill-Death ratio. As a matter of fact, my skills are so
good I was seriously considering ending my programming career to become a pro valorant player, but I decided to wait and see how this whole
"Google" "Internship" thing panned out first.
</p>
<a href=/playPage.html id=smallButton> << Back </a>
<div class=footer>
<a href="https://www.github.com/Bode2222/"> <img src="/Pics/gitlogo.png" alt="Github" width="50" height="50"> </a>
</div>
</div>
</body>
</html> |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../includes/main.css" type="text/css">
<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon">
<title>Apache CloudStack | The Power Behind Your Cloud</title>
</head>
<body>
<div id="insidetopbg">
<div id="inside_wrapper">
<div class="uppermenu_panel">
<div class="uppermenu_box"></div>
</div>
<div id="main_master">
<div id="inside_header">
<div class="header_top">
<a class="cloud_logo" href="http://cloudstack.org"></a>
<div class="mainemenu_panel"></div>
</div>
</div>
<div id="main_content">
<div class="inside_apileftpanel">
<div class="inside_contentpanel" style="width:930px;">
<div class="api_titlebox">
<div class="api_titlebox_left">
<span>
Apache CloudStack v4.1.0 Root Admin API Reference
</span>
<p></p>
<h1>deleteUser</h1>
<p>Deletes a user for an account</p>
</div>
<div class="api_titlebox_right">
<a class="api_backbutton" href="../TOC_Root_Admin.html"></a>
</div>
</div>
<div class="api_tablepanel">
<h2>Request parameters</h2>
<table class="apitable">
<tr class="hed">
<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td>
</tr>
<tr>
<td style="width:200px;"><strong>id</strong></td><td style="width:500px;"><strong>id of the user to be deleted</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
</table>
</div>
<div class="api_tablepanel">
<h2>Response Tags</h2>
<table class="apitable">
<tr class="hed">
<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td>
</tr>
<tr>
<td style="width:200px;"><strong>displaytext</strong></td><td style="width:500px;">any text associated with the success or failure</td>
</tr>
<tr>
<td style="width:200px;"><strong>success</strong></td><td style="width:500px;">true if operation is executed successfully</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer_mainmaster">
<p>Copyright © 2012 The Apache Software Foundation, Licensed under the
<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a>
<br>
Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
</div>
</div>
</div>
</div>
</body>
</html>
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_292) on Fri Jul 02 03:47:31 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Arrow.PickupRule (Glowkit 1.12.2-R6.0-SNAPSHOT API)</title>
<meta name="date" content="2021-07-02">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Arrow.PickupRule (Glowkit 1.12.2-R6.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":41,"i1":41};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Arrow.PickupRule.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/bukkit/entity/Arrow.html" title="interface in org.bukkit.entity"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/bukkit/entity/Arrow.PickupStatus.html" title="enum in org.bukkit.entity"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/bukkit/entity/Arrow.PickupRule.html" target="_top">Frames</a></li>
<li><a href="Arrow.PickupRule.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#enum.constant.summary">Enum Constants</a> | </li>
<li>Field | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
<li>Field | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.bukkit.entity</div>
<h2 title="Enum Arrow.PickupRule" class="title">Enum Arrow.PickupRule</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../org/bukkit/entity/Arrow.PickupRule.html" title="enum in org.bukkit.entity">Arrow.PickupRule</a>></li>
<li>
<ul class="inheritance">
<li>org.bukkit.entity.Arrow.PickupRule</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../org/bukkit/entity/Arrow.PickupRule.html" title="enum in org.bukkit.entity">Arrow.PickupRule</a>></dd>
</dl>
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="../../../org/bukkit/entity/Arrow.html" title="interface in org.bukkit.entity">Arrow</a></dd>
</dl>
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static enum <span class="typeNameLabel">Arrow.PickupRule</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../org/bukkit/entity/Arrow.PickupRule.html" title="enum in org.bukkit.entity">Arrow.PickupRule</a>></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Enum Constant and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/bukkit/entity/Arrow.PickupRule.html#ALLOWED">ALLOWED</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/bukkit/entity/Arrow.PickupRule.html#CREATIVE_ONLY">CREATIVE_ONLY</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/bukkit/entity/Arrow.PickupRule.html#DISALLOWED">DISALLOWED</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../org/bukkit/entity/Arrow.PickupRule.html" title="enum in org.bukkit.entity">Arrow.PickupRule</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/bukkit/entity/Arrow.PickupRule.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/bukkit/entity/Arrow.PickupRule.html" title="enum in org.bukkit.entity">Arrow.PickupRule</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/bukkit/entity/Arrow.PickupRule.html#values--">values</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a name="DISALLOWED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DISALLOWED</h4>
<pre>public static final <a href="../../../org/bukkit/entity/Arrow.PickupRule.html" title="enum in org.bukkit.entity">Arrow.PickupRule</a> DISALLOWED</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
</li>
</ul>
<a name="ALLOWED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ALLOWED</h4>
<pre>public static final <a href="../../../org/bukkit/entity/Arrow.PickupRule.html" title="enum in org.bukkit.entity">Arrow.PickupRule</a> ALLOWED</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
</li>
</ul>
<a name="CREATIVE_ONLY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CREATIVE_ONLY</h4>
<pre>public static final <a href="../../../org/bukkit/entity/Arrow.PickupRule.html" title="enum in org.bukkit.entity">Arrow.PickupRule</a> CREATIVE_ONLY</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="values--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public static <a href="../../../org/bukkit/entity/Arrow.PickupRule.html" title="enum in org.bukkit.entity">Arrow.PickupRule</a>[] values()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (Arrow.PickupRule c : Arrow.PickupRule.values())
System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a name="valueOf-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static <a href="../../../org/bukkit/entity/Arrow.PickupRule.html" title="enum in org.bukkit.entity">Arrow.PickupRule</a> valueOf(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Arrow.PickupRule.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/bukkit/entity/Arrow.html" title="interface in org.bukkit.entity"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/bukkit/entity/Arrow.PickupStatus.html" title="enum in org.bukkit.entity"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/bukkit/entity/Arrow.PickupRule.html" target="_top">Frames</a></li>
<li><a href="Arrow.PickupRule.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#enum.constant.summary">Enum Constants</a> | </li>
<li>Field | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
<li>Field | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2021. All rights reserved.</small></p>
</body>
</html>
|
<html lang="en">
<head>
<title>1 Samuel 17:24</title>
<link rel="stylesheet" href="../../../verse.css">
</head>
<body>
<div id="container">
<div id="wrapper">
<div id="metadata">1 Samuel 17:24</div>
<div id="verse">And all the men of Israel, when they saw the man, fled from him, and were sore afraid.</div>
</div>
</div>
</body>
</html> |
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../../../">
<title data-ice="title">FeedbackGroup | jsxapi</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
<meta name="description" content="JavaScript bindings for XAPI"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="jsxapi"><meta property="twitter:description" content="JavaScript bindings for XAPI"></head>
<body class="layout-container" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
</header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/json-parser.js~JSONParser.html">JSONParser</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-connect">connect</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-parseJSON">parseJSON</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-external">E</span><span data-ice="name"><span><a href="https://nodejs.org/api/stream.html#stream_class_stream_transform">Transform</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#backend">backend</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/backend/tsh.js~TSHBackend.html">TSHBackend</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/backend/ws.js~WSBackend.html">WSBackend</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-interface">I</span><span data-ice="name"><span><a href="class/src/backend/index.js~Backend.html">Backend</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-external">E</span><span data-ice="name"><span><a href="https://nodejs.org/api/events.html#events_class_eventemitter">EventEmitter</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-external">E</span><span data-ice="name"><span><a href="https://nodejs.org/api/stream.html#stream_class_stream_duplex">Duplex</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-external">E</span><span data-ice="name"><span><a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSocket">WebSocket</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#transport">transport</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/transport/stream.js~StreamTransport.html">StreamTransport</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-connectSSH">connectSSH</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-spawnTSH">spawnTSH</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#xapi">xapi</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/xapi/components.js~Config.html">Config</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/xapi/components.js~Event.html">Event</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/xapi/components.js~Status.html">Status</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/xapi/exc.js~IllegalValueError.html">IllegalValueError</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/xapi/exc.js~InvalidPathError.html">InvalidPathError</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/xapi/exc.js~ParameterError.html">ParameterError</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/xapi/exc.js~XAPIError.html">XAPIError</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/xapi/feedback.js~Feedback.html">Feedback</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/xapi/feedback.js~FeedbackGroup.html">FeedbackGroup</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/xapi/index.js~XAPI.html">XAPI</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-interface">I</span><span data-ice="name"><span><a href="class/src/xapi/components.js~Component.html">Component</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-interface">I</span><span data-ice="name"><span><a href="class/src/xapi/mixins.js~Gettable.html">Gettable</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-interface">I</span><span data-ice="name"><span><a href="class/src/xapi/mixins.js~Listenable.html">Listenable</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-interface">I</span><span data-ice="name"><span><a href="class/src/xapi/mixins.js~Settable.html">Settable</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-mix">mix</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-normalizePath">normalizePath</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-collapse">collapse</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-createCommandResponse">createCommandResponse</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-createErrorResponse">createErrorResponse</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-createGetResponse">createGetResponse</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-createRequest">createRequest</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-createResponse">createResponse</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-createSetResponse">createSetResponse</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-parseFeedbackResponse">parseFeedbackResponse</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-COMMAND_ERROR">COMMAND_ERROR</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-ILLEGAL_VALUE">ILLEGAL_VALUE</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-INVALID_PATH">INVALID_PATH</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-INVALID_RESPONSE">INVALID_RESPONSE</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-INVALID_STATUS">INVALID_STATUS</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-METHOD_NOT_FOUND">METHOD_NOT_FOUND</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-PARAMETER_ERROR">PARAMETER_ERROR</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-UNKNOWN_ERROR">UNKNOWN_ERROR</a></span></span></li>
</ul>
</div>
</nav>
<div class="content" data-ice="content"><div class="header-notice">
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {FeedbackGroup} from '<span><a href="file/src/xapi/feedback.js.html#lineNumber10">jsxapi/lib/xapi/feedback.js</a></span>'</code></pre></div>
<span data-ice="access">public</span>
<span data-ice="kind">class</span>
<span data-ice="source">| <span><a href="file/src/xapi/feedback.js.html#lineNumber10">source</a></span></span>
</div>
<div class="self-detail detail">
<h1 data-ice="name">FeedbackGroup</h1>
<div class="description" data-ice="description"><p>Group feedback deregister handlers for bookkeeping.</p>
</div>
</div>
<div data-ice="constructorSummary"><h2>Constructor Summary</h2><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Public Constructor</td></tr></thead>
<tbody>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span class="code" data-ice="name"><span><a href="class/src/xapi/feedback.js~FeedbackGroup.html#instance-constructor-constructor">constructor</a></span></span><span class="code" data-ice="signature">()</span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<div data-ice="memberSummary"><h2>Member Summary</h2><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Public Members</td></tr></thead>
<tbody>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span class="code" data-ice="name"><span><a href="class/src/xapi/feedback.js~FeedbackGroup.html#instance-member-handlers">handlers</a></span></span><span class="code" data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<div data-ice="methodSummary"><h2>Method Summary</h2><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Public Methods</td></tr></thead>
<tbody>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span class="code" data-ice="name"><span><a href="class/src/xapi/feedback.js~FeedbackGroup.html#instance-method-add">add</a></span></span><span class="code" data-ice="signature">(handler: <span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span><span>()</span></span>): <span><a href="class/src/xapi/feedback.js~FeedbackGroup.html">FeedbackGroup</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Add a deregister handler function to the feedback group.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span class="code" data-ice="name"><span><a href="class/src/xapi/feedback.js~FeedbackGroup.html#instance-method-off">off</a></span></span><span class="code" data-ice="signature">(): <span><a href="class/src/xapi/feedback.js~FeedbackGroup.html">FeedbackGroup</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Call the deregister handler functions associated with this group.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span class="code" data-ice="name"><span><a href="class/src/xapi/feedback.js~FeedbackGroup.html#instance-method-remove">remove</a></span></span><span class="code" data-ice="signature">(handler: <span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span><span>()</span></span>): <span><a href="class/src/xapi/feedback.js~FeedbackGroup.html">FeedbackGroup</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Remove a deregister handler function from the feedback group.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<div data-ice="constructorDetails"><h2 data-ice="title">Public Constructors</h2>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-constructor-constructor">
<span class="access" data-ice="access">public</span>
<span class="code" data-ice="name">constructor</span><span class="code" data-ice="signature">()</span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/xapi/feedback.js.html#lineNumber11">source</a></span></span>
</span>
</h3>
<div data-ice="properties">
</div>
</div>
</div>
<div data-ice="memberDetails"><h2 data-ice="title">Public Members</h2>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-member-handlers">
<span class="access" data-ice="access">public</span>
<span class="code" data-ice="name">handlers</span><span class="code" data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/xapi/feedback.js.html#lineNumber12">source</a></span></span>
</span>
</h3>
<div data-ice="properties">
</div>
</div>
</div>
<div data-ice="methodDetails"><h2 data-ice="title">Public Methods</h2>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-method-add">
<span class="access" data-ice="access">public</span>
<span class="code" data-ice="name">add</span><span class="code" data-ice="signature">(handler: <span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span><span>()</span></span>): <span><a href="class/src/xapi/feedback.js~FeedbackGroup.html">FeedbackGroup</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/xapi/feedback.js.html#lineNumber21">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Add a deregister handler function to the feedback group.</p>
</div>
<div data-ice="properties"><div data-ice="properties">
<h4 data-ice="title">Params:</h4>
<table class="params">
<thead>
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
</thead>
<tbody>
<tr data-ice="property" data-depth="0">
<td data-ice="name" class="code" data-depth="0">handler</td>
<td data-ice="type" class="code"><span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span><span>()</span></span></td>
<td data-ice="appendix"></td>
<td data-ice="description"><p>Handler to add to the group.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type code" data-ice="returnType"><span><a href="class/src/xapi/feedback.js~FeedbackGroup.html">FeedbackGroup</a></span></td>
<td class="return-desc" data-ice="returnDescription"><p>this for chaining.</p>
</td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-method-off">
<span class="access" data-ice="access">public</span>
<span class="code" data-ice="name">off</span><span class="code" data-ice="signature">(): <span><a href="class/src/xapi/feedback.js~FeedbackGroup.html">FeedbackGroup</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/xapi/feedback.js.html#lineNumber42">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Call the deregister handler functions associated with this group.</p>
</div>
<div data-ice="properties">
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type code" data-ice="returnType"><span><a href="class/src/xapi/feedback.js~FeedbackGroup.html">FeedbackGroup</a></span></td>
<td class="return-desc" data-ice="returnDescription"><p>this for chaining.</p>
</td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-method-remove">
<span class="access" data-ice="access">public</span>
<span class="code" data-ice="name">remove</span><span class="code" data-ice="signature">(handler: <span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span><span>()</span></span>): <span><a href="class/src/xapi/feedback.js~FeedbackGroup.html">FeedbackGroup</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/xapi/feedback.js.html#lineNumber32">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Remove a deregister handler function from the feedback group.</p>
</div>
<div data-ice="properties"><div data-ice="properties">
<h4 data-ice="title">Params:</h4>
<table class="params">
<thead>
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
</thead>
<tbody>
<tr data-ice="property" data-depth="0">
<td data-ice="name" class="code" data-depth="0">handler</td>
<td data-ice="type" class="code"><span><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span><span>()</span></span></td>
<td data-ice="appendix"></td>
<td data-ice="description"><p>Handler to remove from the group.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type code" data-ice="returnType"><span><a href="class/src/xapi/feedback.js~FeedbackGroup.html">FeedbackGroup</a></span></td>
<td class="return-desc" data-ice="returnDescription"><p>this for chaining.</p>
</td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(1.1.0)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<TITLE> [antlr-interest] Order of token matching
</TITLE>
<LINK REL="Index" HREF="index.html" >
<LINK REL="made" HREF="mailto:antlr-interest%40antlr.org?Subject=Re:%20%5Bantlr-interest%5D%20Order%20of%20token%20matching&In-Reply-To=%3Cac4d76b463496386f98608e7d1388e97%40lehre.ba-stuttgart.de%3E">
<META NAME="robots" CONTENT="index,nofollow">
<META http-equiv="Content-Type" content="text/html; charset=us-ascii">
<LINK REL="Previous" HREF="030502.html">
<LINK REL="Next" HREF="030504.html">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H1>[antlr-interest] Order of token matching</H1>
<B>Jenny Balfer</B>
<A HREF="mailto:antlr-interest%40antlr.org?Subject=Re:%20%5Bantlr-interest%5D%20Order%20of%20token%20matching&In-Reply-To=%3Cac4d76b463496386f98608e7d1388e97%40lehre.ba-stuttgart.de%3E"
TITLE="[antlr-interest] Order of token matching">ai06087 at Lehre.BA-Stuttgart.De
</A><BR>
<I>Wed Sep 3 09:34:10 PDT 2008</I>
<P><UL>
<LI>Previous message: <A HREF="030502.html">[antlr-interest] Order of token matching
</A></li>
<LI>Next message: <A HREF="030504.html">[antlr-interest] Order of token matching
</A></li>
<LI> <B>Messages sorted by:</B>
<a href="date.html#30503">[ date ]</a>
<a href="thread.html#30503">[ thread ]</a>
<a href="subject.html#30503">[ subject ]</a>
<a href="author.html#30503">[ author ]</a>
</LI>
</UL>
<HR>
<!--beginarticle-->
<PRE>No, it is too long. But I reproduced the error in a short one.
An example for the occuring error would be the following string:
isWorking = function(param1,param2) {
some implementation;
some expressions;
}
function throwsError(param1, param2) {
// this is a nasty comment {
something else
}
function isIgnored() {
// lexer is still searching for a closing brace
}
***********
* GRAMMAR *
***********
program : statement*
;
statement
: '(' statement ')'
| declaration
;
declaration
: ID '=' FUNCTION '(' paramList ')'
| FUNCTION ID '(' paramList ')'
;
paramList
: ID (',' ID)*
;
fragment LDOC
: '/**'
;
fragment MLCOM
: '/*'
;
fragment SLCOM
: '//'
;
fragment RCOM
: '*/'
;
FUNCTION: 'function'
;
COMMENT
: SLCOM (options{greedy=false;}: .)* NL {skip();}
| MLCOM (options{greedy=false;}: .)* RCOM {skip();}
;
IMPL
: '{' (IMPL|~'}')* '}' {skip();}
;
NL
: '\r' {skip();}
| '\n' {skip();}
;
WS
: ' ' {$channel=HIDDEN;}
| '\t' {skip();}
;
ID : ( LETTER | '$' | '_' ) ( LETTER | '$' | '_' | DIGIT )*
;
fragment LETTER
: 'A'..'Z'
| 'a'..'z'
;
fragment DIGIT
: '0'..'9'
;
DEFAULT : .
;
On Wed, 03 Sep 2008 09:21:00 -0700, Jim Idle <<A HREF="http://www.antlr.org/mailman/listinfo/antlr-interest">jimi at temporal-wave.com</A>>
wrote:
><i> On Wed, 2008-09-03 at 18:14 +0200, Jenny Balfer wrote:
</I>><i>
</I>>><i> Thanks for that, but unfortunately this does not solve the problem. I
</I>>><i> declared MLCOM etc. as fragment, but COMMENT and IMPL must not be
</I>><i> fragments
</I>>><i> in order to skip them.
</I>><i>
</I>><i>
</I>><i> Have you shown all of your grammar here?
</I>><i>
</I>><i> Jim
</I>><i>
</I>>><i>
</I>>><i> On Wed, 03 Sep 2008 09:05:48 -0700, Jim Idle <<A HREF="http://www.antlr.org/mailman/listinfo/antlr-interest">jimi at temporal-wave.com</A>>
</I>>><i> wrote:
</I>>><i> > On Wed, 2008-09-03 at 18:00 +0200, Jenny Balfer wrote:
</I>>><i> >
</I>>><i> >> Hello guys,
</I>>><i> >>
</I>>><i> >> I think I have too little understanding of the work of my lexer. I
</I>>><i> > thought
</I>>><i> >> the rules that are specified first are matched first, but in my
</I>><i> grammar
</I>>><i> >> this is not the case.
</I>>><i> >> What I am trying to do is first skipping all comments of my source
</I>>><i> > files,
</I>>><i> >> and then skipping everything between curly braces:
</I>>><i> >>
</I>>><i> >
</I>>><i> >
</I>>><i> > Make sure that any token that you don't want returned to the parser is
</I>><i> a
</I>>><i> > fragment:
</I>>><i> >
</I>>><i> > fragment
</I>>><i> > MLCOM : '/*' ;
</I>>><i> >
</I>>><i> > etc. Then you should have more luck, your comment lead-ins are
</I>><i> matching
</I>>><i> > the MLCOM and SLCOM rules and then likely throwing recognition errors
</I>>><i> > for the rest up until the '{'
</I>>><i> >
</I>>><i> > Jim
</I>>><i> >
</I>>><i> >
</I>>><i> >> MLCOM : '/*'
</I>>><i> >> ;
</I>>><i> >> SLCOM : '//'
</I>>><i> >> ;
</I>>><i> >> RCOM : '*/'
</I>>><i> >> ;
</I>>><i> >> NL : '\r' {skip();}
</I>>><i> >> | '\n' {skip();}
</I>>><i> >> ;
</I>>><i> >> WS : ' ' {$channel=HIDDEN;}
</I>>><i> >> | '\t' {skip();}
</I>>><i> >> ;
</I>>><i> >>
</I>>><i> >> COMMENT : SLCOM (options{greedy=false;}: .)* NL {skip();}
</I>>><i> >> | MLCOM (options{greedy=false;}: .)* RCOM {skip();}
</I>>><i> >> ;
</I>>><i> >> IMPL : '{' (IMPL|'}')* '}' {skip();}
</I>>><i> >> ;
</I>>><i> >>
</I>>><i> >> Rule IMPL matches everything between curly braces, but in between
</I>><i> counts
</I>>><i> >> them (by recursively calling itself).
</I>>><i> >> Now the problem appears if there are braces in comments:
</I>>><i> >>
</I>>><i> >> someFunction = function(a,b) {
</I>>><i> >> // this is one brace too much: {
</I>>><i> >> }
</I>>><i> >>
</I>>><i> >> My lexer now sees the opening brace in the comment and searches for
</I>><i> the
</I>>><i> >> closing one until the end of file, which results in:
</I>>><i> >> mismatched character '<EOF>' expecting '}'
</I>>><i> >>
</I>>><i> >> What I want my lexer to do is first sort out all comments, and second
</I>>><i> > sort
</I>>><i> >> out everything between curly braces. Are there any predicates that
</I>><i> could
</I>>><i> >> cause this?
</I>>><i> >>
</I>>><i> >> Thanks!
</I>>><i> >>
</I>>><i> >>
</I>>><i> >> List: <A HREF="http://www.antlr.org/mailman/listinfo/antlr-interest">http://www.antlr.org/mailman/listinfo/antlr-interest</A>
</I>>><i> >> Unsubscribe:
</I>>><i> >
</I>>><i>
</I>><i>
</I><A HREF="http://www.antlr.org/mailman/options/antlr-interest/your-email-address">http://www.antlr.org/mailman/options/antlr-interest/your-email-address</A>
>><i> >>
</I>>><i>
</I>
</PRE>
<!--endarticle-->
<HR>
<P><UL>
<!--threads-->
<LI>Previous message: <A HREF="030502.html">[antlr-interest] Order of token matching
</A></li>
<LI>Next message: <A HREF="030504.html">[antlr-interest] Order of token matching
</A></li>
<LI> <B>Messages sorted by:</B>
<a href="date.html#30503">[ date ]</a>
<a href="thread.html#30503">[ thread ]</a>
<a href="subject.html#30503">[ subject ]</a>
<a href="author.html#30503">[ author ]</a>
</LI>
</UL>
<hr>
<a href="http://www.antlr.org/mailman/listinfo/antlr-interest">More information about the antlr-interest
mailing list</a><br>
</body></html>
|
{% extends "base.html" %}
{% block title %} Change Password- {{ block.super }} {% endblock %}
{% block body %}
<h1>Password changed</h1>
<p>Your password has been successfully changed.</p>
{% endblock %} |
<!DOCTYPE html>
<html lang="en">
<head>
<title>STPThreeDSLabelCustomization Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/STPThreeDSLabelCustomization" class="dashAnchor"></a>
<a title="STPThreeDSLabelCustomization Class Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../../index.html">
Stripe iOS SDKs 21.8.1
</a>
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/stripe/stripe-ios">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../../index.html">Stripe iOS SDKs</a>
<img class="carat" src="../img/carat.png" />
<a class="breadcrumb" href="../index.html">Stripe</a>
<img class="carat" src="../img/carat.png" />
STPThreeDSLabelCustomization Class Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PaymentSheet.html">PaymentSheet</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PaymentSheet/PaymentButton.html">– PaymentButton</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PaymentSheet/FlowController.html">– FlowController</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PaymentSheet/UserInterfaceStyle.html">– UserInterfaceStyle</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PaymentSheet/Configuration.html">– Configuration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PaymentSheet/CustomerConfiguration.html">– CustomerConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PaymentSheet/ApplePayConfiguration.html">– ApplePayConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPAPIClient.html">STPAPIClient</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPAUBECSDebitFormView.html">STPAUBECSDebitFormView</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPAddCardViewController.html">STPAddCardViewController</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPAddress.html">STPAddress</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPAppInfo.html">STPAppInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPApplePayContext.html">STPApplePayContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPApplePayPaymentOption.html">STPApplePayPaymentOption</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPBankAccount.html">STPBankAccount</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPBankAccountParams.html">STPBankAccountParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPBankSelectionViewController.html">STPBankSelectionViewController</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPCard.html">STPCard</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPCardBrandUtilities.html">STPCardBrandUtilities</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPCardFormView.html">STPCardFormView</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPCardFormView/Representable.html">– Representable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPCardParams.html">STPCardParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPCardValidator.html">STPCardValidator</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPConfirmAlipayOptions.html">STPConfirmAlipayOptions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPConfirmBLIKOptions.html">STPConfirmBLIKOptions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPConfirmCardOptions.html">STPConfirmCardOptions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPConfirmPaymentMethodOptions.html">STPConfirmPaymentMethodOptions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPConfirmWeChatPayOptions.html">STPConfirmWeChatPayOptions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPConnectAccountAddress.html">STPConnectAccountAddress</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPConnectAccountCompanyParams.html">STPConnectAccountCompanyParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPConnectAccountIndividualParams.html">STPConnectAccountIndividualParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPConnectAccountIndividualVerification.html">STPConnectAccountIndividualVerification</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPConnectAccountParams.html">STPConnectAccountParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPConnectAccountVerificationDocument.html">STPConnectAccountVerificationDocument</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPContactField.html">STPContactField</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPCoreScrollViewController.html">STPCoreScrollViewController</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPCoreTableViewController.html">STPCoreTableViewController</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPCoreViewController.html">STPCoreViewController</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPCustomer.html">STPCustomer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPCustomerContext.html">STPCustomerContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPCustomerDeserializer.html">STPCustomerDeserializer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPDateOfBirth.html">STPDateOfBirth</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPError.html">STPError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPFPXBank.html">STPFPXBank</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPFakeAddPaymentPassViewController.html">STPFakeAddPaymentPassViewController</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPFile.html">STPFile</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes.html#/c:@M@Stripe@objc(cs)STPFormView">STPFormView</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPImageLibrary.html">STPImageLibrary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPIntentAction.html">STPIntentAction</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPIntentActionAlipayHandleRedirect.html">STPIntentActionAlipayHandleRedirect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPIntentActionOXXODisplayDetails.html">STPIntentActionOXXODisplayDetails</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPIntentActionRedirectToURL.html">STPIntentActionRedirectToURL</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPIntentActionWechatPayRedirectToApp.html">STPIntentActionWechatPayRedirectToApp</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPIssuingCardPin.html">STPIssuingCardPin</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPKlarnaLineItem.html">STPKlarnaLineItem</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPMandateCustomerAcceptanceParams.html">STPMandateCustomerAcceptanceParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPMandateDataParams.html">STPMandateDataParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPMandateOnlineParams.html">STPMandateOnlineParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPMultiFormTextField.html">STPMultiFormTextField</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentActivityIndicatorView.html">STPPaymentActivityIndicatorView</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentCardTextField.html">STPPaymentCardTextField</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentCardTextField/Representable.html">– Representable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentConfiguration.html">STPPaymentConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentContext.html">STPPaymentContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentHandler.html">STPPaymentHandler</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentIntent.html">STPPaymentIntent</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes.html#/c:@M@Stripe@objc(cs)STPPaymentIntentAction">STPPaymentIntentAction</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentIntentLastPaymentError.html">STPPaymentIntentLastPaymentError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentIntentParams.html">STPPaymentIntentParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentIntentShippingDetails.html">STPPaymentIntentShippingDetails</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentIntentShippingDetailsAddress.html">STPPaymentIntentShippingDetailsAddress</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentIntentShippingDetailsAddressParams.html">STPPaymentIntentShippingDetailsAddressParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentIntentShippingDetailsParams.html">STPPaymentIntentShippingDetailsParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethod.html">STPPaymentMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodAUBECSDebit.html">STPPaymentMethodAUBECSDebit</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodAUBECSDebitParams.html">STPPaymentMethodAUBECSDebitParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodAddress.html">STPPaymentMethodAddress</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodAfterpayClearpay.html">STPPaymentMethodAfterpayClearpay</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodAfterpayClearpayParams.html">STPPaymentMethodAfterpayClearpayParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes.html#/c:@M@Stripe@objc(cs)STPPaymentMethodAlipay">STPPaymentMethodAlipay</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodAlipayParams.html">STPPaymentMethodAlipayParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes.html#/c:@M@Stripe@objc(cs)STPPaymentMethodBLIK">STPPaymentMethodBLIK</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodBLIKParams.html">STPPaymentMethodBLIKParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodBacsDebit.html">STPPaymentMethodBacsDebit</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodBacsDebitParams.html">STPPaymentMethodBacsDebitParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodBancontact.html">STPPaymentMethodBancontact</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodBancontactParams.html">STPPaymentMethodBancontactParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodBillingDetails.html">STPPaymentMethodBillingDetails</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodCard.html">STPPaymentMethodCard</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodCardChecks.html">STPPaymentMethodCardChecks</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodCardNetworks.html">STPPaymentMethodCardNetworks</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodCardParams.html">STPPaymentMethodCardParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodCardPresent.html">STPPaymentMethodCardPresent</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodCardWallet.html">STPPaymentMethodCardWallet</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodCardWalletMasterpass.html">STPPaymentMethodCardWalletMasterpass</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodCardWalletVisaCheckout.html">STPPaymentMethodCardWalletVisaCheckout</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodEPS.html">STPPaymentMethodEPS</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodEPSParams.html">STPPaymentMethodEPSParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodFPX.html">STPPaymentMethodFPX</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodFPXParams.html">STPPaymentMethodFPXParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodGiropay.html">STPPaymentMethodGiropay</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodGiropayParams.html">STPPaymentMethodGiropayParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodGrabPay.html">STPPaymentMethodGrabPay</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodGrabPayParams.html">STPPaymentMethodGrabPayParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodNetBanking.html">STPPaymentMethodNetBanking</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodNetBankingParams.html">STPPaymentMethodNetBankingParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodOXXO.html">STPPaymentMethodOXXO</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodOXXOParams.html">STPPaymentMethodOXXOParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodParams.html">STPPaymentMethodParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodPrzelewy24.html">STPPaymentMethodPrzelewy24</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodPrzelewy24Params.html">STPPaymentMethodPrzelewy24Params</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodSEPADebit.html">STPPaymentMethodSEPADebit</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodSEPADebitParams.html">STPPaymentMethodSEPADebitParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodSofort.html">STPPaymentMethodSofort</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodSofortParams.html">STPPaymentMethodSofortParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodThreeDSecureUsage.html">STPPaymentMethodThreeDSecureUsage</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodUPI.html">STPPaymentMethodUPI</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodUPIParams.html">STPPaymentMethodUPIParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodWeChatPay.html">STPPaymentMethodWeChatPay</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodWeChatPayParams.html">STPPaymentMethodWeChatPayParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodiDEAL.html">STPPaymentMethodiDEAL</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentMethodiDEALParams.html">STPPaymentMethodiDEALParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentOptionsViewController.html">STPPaymentOptionsViewController</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPaymentResult.html">STPPaymentResult</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPinManagementService.html">STPPinManagementService</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPushProvisioningContext.html">STPPushProvisioningContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPPushProvisioningDetailsParams.html">STPPushProvisioningDetailsParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPRadarSession.html">STPRadarSession</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPRedirectContext.html">STPRedirectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSetupIntent.html">STPSetupIntent</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSetupIntentConfirmParams.html">STPSetupIntentConfirmParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSetupIntentLastSetupError.html">STPSetupIntentLastSetupError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPShippingAddressViewController.html">STPShippingAddressViewController</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSource.html">STPSource</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSourceCardDetails.html">STPSourceCardDetails</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSourceKlarnaDetails.html">STPSourceKlarnaDetails</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSourceOwner.html">STPSourceOwner</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSourceParams.html">STPSourceParams</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSourceReceiver.html">STPSourceReceiver</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSourceRedirect.html">STPSourceRedirect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSourceSEPADebitDetails.html">STPSourceSEPADebitDetails</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSourceVerification.html">STPSourceVerification</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPSourceWeChatPayDetails.html">STPSourceWeChatPayDetails</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPTheme.html">STPTheme</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPThreeDSButtonCustomization.html">STPThreeDSButtonCustomization</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPThreeDSCustomizationSettings.html">STPThreeDSCustomizationSettings</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPThreeDSFooterCustomization.html">STPThreeDSFooterCustomization</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPThreeDSLabelCustomization.html">STPThreeDSLabelCustomization</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPThreeDSNavigationBarCustomization.html">STPThreeDSNavigationBarCustomization</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPThreeDSSelectionCustomization.html">STPThreeDSSelectionCustomization</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPThreeDSTextFieldCustomization.html">STPThreeDSTextFieldCustomization</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPThreeDSUICustomization.html">STPThreeDSUICustomization</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPToken.html">STPToken</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/STPUserInformation.html">STPUserInformation</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/StripeAPI.html">StripeAPI</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/PaymentSheetError.html">PaymentSheetError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/PaymentSheetResult.html">PaymentSheetResult</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPBankAccountHolderType.html">STPBankAccountHolderType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPBankAccountStatus.html">STPBankAccountStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPBankSelectionMethod.html">STPBankSelectionMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPBillingAddressFields.html">STPBillingAddressFields</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPCardBrand.html">STPCardBrand</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPCardErrorCode.html">STPCardErrorCode</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPCardFormViewStyle.html">STPCardFormViewStyle</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPCardFundingType.html">STPCardFundingType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPCardValidationState.html">STPCardValidationState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPConnectAccountBusinessType.html">STPConnectAccountBusinessType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPErrorCode.html">STPErrorCode</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPFPXBankBrand.html">STPFPXBankBrand</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPFilePurpose.html">STPFilePurpose</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPIntentActionType.html">STPIntentActionType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPKlarnaLineItemType.html">STPKlarnaLineItemType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPKlarnaPaymentMethods.html">STPKlarnaPaymentMethods</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPMandateCustomerAcceptanceType.html">STPMandateCustomerAcceptanceType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentHandlerActionStatus.html">STPPaymentHandlerActionStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentHandlerErrorCode.html">STPPaymentHandlerErrorCode</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentIntentActionType.html">STPPaymentIntentActionType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentIntentCaptureMethod.html">STPPaymentIntentCaptureMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentIntentConfirmationMethod.html">STPPaymentIntentConfirmationMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentIntentLastPaymentErrorType.html">STPPaymentIntentLastPaymentErrorType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentIntentSetupFutureUsage.html">STPPaymentIntentSetupFutureUsage</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentIntentSourceActionType.html">STPPaymentIntentSourceActionType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentIntentStatus.html">STPPaymentIntentStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentMethodCardCheckResult.html">STPPaymentMethodCardCheckResult</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentMethodCardWalletType.html">STPPaymentMethodCardWalletType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentMethodType.html">STPPaymentMethodType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPaymentStatus.html">STPPaymentStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPPinStatus.html">STPPinStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPRedirectContextError.html">STPRedirectContextError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPRedirectContextState.html">STPRedirectContextState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPSetupIntentLastSetupErrorType.html">STPSetupIntentLastSetupErrorType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPSetupIntentStatus.html">STPSetupIntentStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPSetupIntentUsage.html">STPSetupIntentUsage</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPShippingStatus.html">STPShippingStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPShippingType.html">STPShippingType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPSourceCard3DSecureStatus.html">STPSourceCard3DSecureStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPSourceFlow.html">STPSourceFlow</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPSourceRedirectStatus.html">STPSourceRedirectStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPSourceStatus.html">STPSourceStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPSourceType.html">STPSourceType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPSourceUsage.html">STPSourceUsage</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPSourceVerificationStatus.html">STPSourceVerificationStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPThreeDSButtonTitleStyle.html">STPThreeDSButtonTitleStyle</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPThreeDSCustomizationButtonType.html">STPThreeDSCustomizationButtonType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/STPTokenType.html">STPTokenType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/NSError.html">NSError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/UINavigationBar.html">UINavigationBar</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/View.html">View</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPAPIResponseDecodable.html">STPAPIResponseDecodable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPAUBECSDebitFormViewDelegate.html">STPAUBECSDebitFormViewDelegate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPAddCardViewControllerDelegate.html">STPAddCardViewControllerDelegate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPApplePayContextDelegate.html">STPApplePayContextDelegate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPAuthenticationContext.html">STPAuthenticationContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPBackendAPIAdapter.html">STPBackendAPIAdapter</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPBankSelectionViewControllerDelegate.html">STPBankSelectionViewControllerDelegate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPCardFormViewDelegate.html">STPCardFormViewDelegate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPCustomerEphemeralKeyProvider.html">STPCustomerEphemeralKeyProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols.html#/c:@M@Stripe@objc(pl)STPEphemeralKeyProvider">STPEphemeralKeyProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPFormEncodable.html">STPFormEncodable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPFormTextFieldContainer.html">STPFormTextFieldContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPIssuingCardEphemeralKeyProvider.html">STPIssuingCardEphemeralKeyProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPPaymentCardTextFieldDelegate.html">STPPaymentCardTextFieldDelegate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPPaymentContextDelegate.html">STPPaymentContextDelegate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPPaymentOption.html">STPPaymentOption</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPPaymentOptionsViewControllerDelegate.html">STPPaymentOptionsViewControllerDelegate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPShippingAddressViewControllerDelegate.html">STPShippingAddressViewControllerDelegate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/STPSourceProtocol.html">STPSourceProtocol</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe22STPBooleanSuccessBlocka">STPBooleanSuccessBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe26STPCustomerCompletionBlocka">STPCustomerCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe13STPErrorBlocka">STPErrorBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe22STPFileCompletionBlocka">STPFileCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe36STPIntentClientSecretCompletionBlocka">STPIntentClientSecretCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe30STPJSONResponseCompletionBlocka">STPJSONResponseCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe51STPPaymentHandlerActionPaymentIntentCompletionBlocka">STPPaymentHandlerActionPaymentIntentCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe49STPPaymentHandlerActionSetupIntentCompletionBlocka">STPPaymentHandlerActionSetupIntentCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe31STPPaymentIntentCompletionBlocka">STPPaymentIntentCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe31STPPaymentMethodCompletionBlocka">STPPaymentMethodCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe32STPPaymentMethodsCompletionBlocka">STPPaymentMethodsCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe21STPPaymentStatusBlocka">STPPaymentStatusBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe21STPPinCompletionBlocka">STPPinCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe30STPRadarSessionCompletionBlocka">STPRadarSessionCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe33STPRedirectContextCompletionBlocka">STPRedirectContextCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe46STPRedirectContextPaymentIntentCompletionBlocka">STPRedirectContextPaymentIntentCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe39STPRedirectContextSourceCompletionBlocka">STPRedirectContextSourceCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe29STPSetupIntentCompletionBlocka">STPSetupIntentCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe33STPShippingMethodsCompletionBlocka">STPShippingMethodsCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe24STPSourceCompletionBlocka">STPSourceCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe32STPSourceProtocolCompletionBlocka">STPSourceProtocolCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe23STPTokenCompletionBlocka">STPTokenCompletionBlock</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Stripe12STPVoidBlocka">STPVoidBlock</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>STPThreeDSLabelCustomization</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">STPThreeDSLabelCustomization</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
<p>A customization object to use to configure the UI of a text label.</p>
<div class="slightly-smaller">
<a href="https://github.com/stripe/stripe-ios/tree/21.8.1/Stripe/STPThreeDSLabelCustomization.swift#L17-L67">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/c:@M@Stripe@objc(cs)STPThreeDSLabelCustomization(cm)defaultSettings"></a>
<a name="//apple_ref/swift/Method/defaultSettings()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Stripe@objc(cs)STPThreeDSLabelCustomization(cm)defaultSettings">defaultSettings()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The default settings.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">defaultSettings</span><span class="p">()</span> <span class="o">-></span> <span class="kt">STPThreeDSLabelCustomization</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/stripe/stripe-ios/tree/21.8.1/Stripe/STPThreeDSLabelCustomization.swift#L20-L22">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@Stripe@objc(cs)STPThreeDSLabelCustomization(py)headingFont"></a>
<a name="//apple_ref/swift/Property/headingFont" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Stripe@objc(cs)STPThreeDSLabelCustomization(py)headingFont">headingFont</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The font to use for heading text.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="k">var</span> <span class="nv">headingFont</span><span class="p">:</span> <span class="kt">UIFont</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/stripe/stripe-ios/tree/21.8.1/Stripe/STPThreeDSLabelCustomization.swift#L28-L35">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@Stripe@objc(cs)STPThreeDSLabelCustomization(py)headingTextColor"></a>
<a name="//apple_ref/swift/Property/headingTextColor" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Stripe@objc(cs)STPThreeDSLabelCustomization(py)headingTextColor">headingTextColor</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The color of heading text. Defaults to black.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="k">var</span> <span class="nv">headingTextColor</span><span class="p">:</span> <span class="kt">UIColor</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/stripe/stripe-ios/tree/21.8.1/Stripe/STPThreeDSLabelCustomization.swift#L38-L45">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@Stripe@objc(cs)STPThreeDSLabelCustomization(py)font"></a>
<a name="//apple_ref/swift/Property/font" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Stripe@objc(cs)STPThreeDSLabelCustomization(py)font">font</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The font to use for non-heading text.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="k">var</span> <span class="nv">font</span><span class="p">:</span> <span class="kt">UIFont</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/stripe/stripe-ios/tree/21.8.1/Stripe/STPThreeDSLabelCustomization.swift#L48-L55">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@Stripe@objc(cs)STPThreeDSLabelCustomization(py)textColor"></a>
<a name="//apple_ref/swift/Property/textColor" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Stripe@objc(cs)STPThreeDSLabelCustomization(py)textColor">textColor</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The color to use for non-heading text. Defaults to black.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="k">var</span> <span class="nv">textColor</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/stripe/stripe-ios/tree/21.8.1/Stripe/STPThreeDSLabelCustomization.swift#L58-L65">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="https://stripe.com" target="_blank" rel="external">Stripe</a>. All rights reserved. (Last updated: 2021-08-10)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
|
{% if post.header.teaser %}
{% capture teaser %}{{ post.header.teaser }}{% endcapture %}
{% else %}
{% assign teaser = site.teaser %}
{% endif %}
{% if post.id %}
{% assign title = post.title | markdownify | remove: "<p>" | remove: "</p>" %}
{% else %}
{% assign title = post.title %}
{% endif %}
<div class="{{ include.type | default: 'list' }}__item">
<article class="archive__item" itemscope itemtype="https://schema.org/CreativeWork">
{% if include.type == "grid" and teaser %}
<div class="archive__item-teaser">
<img src="{{ teaser | relative_url }}" alt="">
</div>
{% endif %}
<h2 class="archive__item-title no_toc" itemprop="headline">
{% if post.link %}
<a href="{{ post.link }}">{{ title }}</a> <a href="{{ post.url | relative_url }}" rel="permalink"><i
class="fas fa-link" aria-hidden="true" title="permalink"></i><span class="sr-only">Permalink</span></a>
{% else %}
<a href="{{ post.url | relative_url }}" rel="permalink">{{ title }}</a>
{% endif %}
</h2>
{% if post.date %}
<p class="page__meta"><i class="far fa-fw fa-calendar-alt" aria-hidden="true"></i>
{{ post.date | date: "%B %d %Y" }}</p>
{% endif %}
{% if post.excerpt %}<p class="archive__item-excerpt" itemprop="description">
{{ post.excerpt | markdownify | strip_html | truncate: 160 }}</p>{% endif %}
</article>
</div> |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 1.5.8">
<meta name="author" content="Lightweight Error Augmentation Framework | Emil Dotchevski">
<title>LEAF</title>
<link rel="stylesheet" href="./zajo-dark.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<meta name="keywords" content="c++,error handling,open source">
<meta name="description" content="Lightweight Error Augmentation Framework">
<link rel="stylesheet" href="./zajo-light.css" disabled=true>
<script>
function switch_style()
{
var i, tag;
for( i=0, tag=document.getElementsByTagName("link"); i<tag.length; i++ )
if( tag[i].rel.indexOf("stylesheet")!=-1 && tag[i].href.includes("zajo-") )
tag[i].disabled = !tag[i].disabled;
}
</script>
</head>
<body class="article toc2 toc-left">
<div id="header">
<h1>LEAF<a href="https://ci.appveyor.com/project/zajo/leaf/branch/master"><img style="margin-left:8px; margin-top:21px; float:right; vertical-align: top" src="https://ci.appveyor.com/api/projects/status/u7mq10n8y5ewpre3/branch/master?svg=true"></a> <a href="https://travis-ci.com/boostorg/leaf"><img style="margin-top:21px; float:right; vertical-align: top" src="https://travis-ci.com/boostorg/leaf.svg?branch=master"></a><div style="z-index: 3; bottom:-16px; right:4px; position:fixed"><input width="32" height="32" type="image" alt="Skin" src="./skin.png" onclick="this.blur();switch_style();return false;"/></div></h1>
<div class="details">
<span id="author" class="author">Lightweight Error Augmentation Framework | Emil Dotchevski</span><br>
</div>
<div id="toc" class="toc2">
<div id="toctitle"></div>
<ul class="sectlevel1">
<li><a href="#_abstract">Abstract</a></li>
<li><a href="#support">Support</a></li>
<li><a href="#distribution">Distribution and Portability</a></li>
<li><a href="#introduction">Five Minute Introduction</a>
<ul class="sectlevel2">
<li><a href="#introduction-result"><code>noexcept</code> API</a></li>
<li><a href="#introduction-eh">Exception-Handling API</a></li>
</ul>
</li>
<li><a href="#tutorial">Tutorial</a>
<ul class="sectlevel2">
<li><a href="#tutorial-model">Error Communication Model</a>
<ul class="sectlevel3">
<li><a href="#_noexcept_api"><code>noexcept</code> API</a></li>
<li><a href="#_exception_handling_api">Exception-Handling API</a></li>
<li><a href="#tutorial-interoperability">Interoperability</a></li>
</ul>
</li>
<li><a href="#tutorial-loading">Loading of Error Objects</a></li>
<li><a href="#tutorial-on_error">Using <code>on_error</code></a></li>
<li><a href="#tutorial-predicates">Using Predicates to Handle Errors</a></li>
<li><a href="#tutorial-binding_handlers">Binding Error Handlers in a <code>std::tuple</code></a></li>
<li><a href="#tutorial-async">Transporting Error Objects Between Threads</a>
<ul class="sectlevel3">
<li><a href="#tutorial-async_result">Using <code>result<T></code></a></li>
<li><a href="#tutorial-async_eh">Using Exception Handling</a></li>
</ul>
</li>
<li><a href="#tutorial-classification">Classification of Failures</a></li>
<li><a href="#tutorial-exception_to_result">Converting Exceptions to <code>result<T></code></a></li>
<li><a href="#tutorial-on_error_in_c_callbacks">Using <code>error_monitor</code> to Report Arbitrary Errors from C-callbacks</a></li>
<li><a href="#tutorial-diagnostic_information">Diagnostic Information</a></li>
<li><a href="#tutorial-std_error_code">Working with <code>std::error_code</code>, <code>std::error_condition</code></a>
<ul class="sectlevel3">
<li><a href="#_introduction">Introduction</a></li>
<li><a href="#_support_in_leaf">Support in LEAF</a></li>
</ul>
</li>
<li><a href="#tutorial-boost_exception_integration">Boost Exception Integration</a></li>
</ul>
</li>
<li><a href="#examples">Examples</a></li>
<li><a href="#synopsis">Synopsis</a>
<ul class="sectlevel2">
<li><a href="#synopsis-reporting">Error Reporting</a>
<ul class="sectlevel3">
<li><a href="#error.hpp"><code>error.hpp</code></a></li>
<li><a href="#common.hpp"><code>common.hpp</code></a></li>
<li><a href="#result.hpp"><code>result.hpp</code></a></li>
<li><a href="#on_error.hpp"><code>on_error.hpp</code></a></li>
<li><a href="#exception.hpp"><code>exception.hpp</code></a></li>
<li><a href="#_capture_hpp"><code>capture.hpp</code></a></li>
</ul>
</li>
<li><a href="#tutorial-handling">Error Handling</a>
<ul class="sectlevel3">
<li><a href="#context.hpp"><code>context.hpp</code></a></li>
<li><a href="#handle_errors.hpp"><code>handle_errors.hpp</code></a></li>
<li><a href="#pred.hpp"><code>pred.hpp</code></a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#functions">Reference: Functions</a>
<ul class="sectlevel2">
<li><a href="#activate_context"><code>activate_context</code></a></li>
<li><a href="#capture"><code>capture</code></a></li>
<li><a href="#context_type_from_handlers"><code>context_type_from_handlers</code></a></li>
<li><a href="#current_error"><code>current_error</code></a></li>
<li><a href="#exception"><code>exception</code></a></li>
<li><a href="#exception_to_result"><code>exception_to_result</code></a></li>
<li><a href="#make_context"><code>make_context</code></a></li>
<li><a href="#make_shared_context"><code>make_shared_context</code></a></li>
<li><a href="#new_error"><code>new_error</code></a></li>
<li><a href="#on_error"><code>on_error</code></a></li>
<li><a href="#try_catch"><code>try_catch</code></a></li>
<li><a href="#try_handle_all"><code>try_handle_all</code></a></li>
<li><a href="#try_handle_some"><code>try_handle_some</code></a></li>
</ul>
</li>
<li><a href="#types">Reference: Types</a>
<ul class="sectlevel2">
<li><a href="#context"><code>context</code></a>
<ul class="sectlevel3">
<li><a href="#context::context">Constructors</a></li>
<li><a href="#context::activate"><code>activate</code></a></li>
<li><a href="#context::deactivate"><code>deactivate</code></a></li>
<li><a href="#context::handle_error"><code>handle_error</code></a></li>
<li><a href="#context::is_active"><code>is_active</code></a></li>
<li><a href="#context::print"><code>print</code></a></li>
<li><a href="#context::propagate"><code>propagate</code></a></li>
</ul>
</li>
<li><a href="#context_activator"><code>context_activator</code></a></li>
<li><a href="#diagnostic_info"><code>diagnostic_info</code></a></li>
<li><a href="#error_id"><code>error_id</code></a>
<ul class="sectlevel3">
<li><a href="#error_id::error_id">Constructors</a></li>
<li><a href="#is_error_id"><code>is_error_id</code></a></li>
<li><a href="#error_id::load"><code>load</code></a></li>
<li><a href="#error_id::comparison_operators"><code>operator==</code>, <code>!=</code>, <code><</code></a></li>
<li><a href="#error_id::operator_bool"><code>operator bool</code></a></li>
<li><a href="#error_id::to_error_code"><code>to_error_code</code></a></li>
<li><a href="#error_id::value"><code>value</code></a></li>
</ul>
</li>
<li><a href="#error_monitor"><code>error_monitor</code></a></li>
<li><a href="#e_api_function"><code>e_api_function</code></a></li>
<li><a href="#e_at_line"><code>e_at_line</code></a></li>
<li><a href="#e_errno"><code>e_errno</code></a></li>
<li><a href="#e_file_name"><code>e_file_name</code></a></li>
<li><a href="#e_LastError"><code>e_LastError</code></a></li>
<li><a href="#e_source_location"><code>e_source_location</code></a></li>
<li><a href="#e_type_info_name"><code>e_type_info_name</code></a></li>
<li><a href="#error_info"><code>error_info</code></a></li>
<li><a href="#polymorphic_context"><code>polymorphic_context</code></a></li>
<li><a href="#result"><code>result</code></a>
<ul class="sectlevel3">
<li><a href="#result::result">Constructors</a></li>
<li><a href="#result::error"><code>error</code></a></li>
<li><a href="#result::load"><code>load</code></a></li>
<li><a href="#result::operator_eq"><code>operator=</code></a></li>
<li><a href="#result::operator_bool"><code>operator bool</code></a></li>
<li><a href="#result::value"><code>value</code>, <code>operator*</code>, <code>-></code></a></li>
</ul>
</li>
<li><a href="#verbose_diagnostic_info"><code>verbose_diagnostic_info</code></a></li>
</ul>
</li>
<li><a href="#predicates">Reference: Predicates</a>
<ul class="sectlevel2">
<li><a href="#catch_"><code>catch_</code></a></li>
<li><a href="#if_not"><code>if_not</code></a></li>
<li><a href="#match"><code>match</code></a></li>
<li><a href="#match_member"><code>match_member</code></a></li>
<li><a href="#match_value"><code>match_value</code></a></li>
</ul>
</li>
<li><a href="#traits">Reference: Traits</a>
<ul class="sectlevel2">
<li><a href="#is_predicate"><code>is_predicate</code></a></li>
<li><a href="#is_result_type"><code>is_result_type</code></a></li>
</ul>
</li>
<li><a href="#macros">Reference: Macros</a>
<ul class="sectlevel2">
<li><a href="#BOOST_LEAF_ASSIGN"><code>BOOST_LEAF_ASSIGN</code></a></li>
<li><a href="#BOOST_LEAF_AUTO"><code>BOOST_LEAF_AUTO</code></a></li>
<li><a href="#BOOST_LEAF_CHECK"><code>BOOST_LEAF_CHECK</code></a></li>
<li><a href="#BOOST_LEAF_EXCEPTION"><code>BOOST_LEAF_EXCEPTION</code></a></li>
<li><a href="#BOOST_LEAF_NEW_ERROR"><code>BOOST_LEAF_NEW_ERROR</code></a></li>
<li><a href="#BOOST_LEAF_THROW_EXCEPTION"><code>BOOST_LEAF_THROW_EXCEPTION</code></a></li>
</ul>
</li>
<li><a href="#rationale">Design</a>
<ul class="sectlevel2">
<li><a href="#_rationale">Rationale</a></li>
<li><a href="#exception_specifications">Critique 1: Error Types Do Not Participate in Function Signatures</a></li>
<li><a href="#translation">Critique 2: LEAF Does Not Facilitate Mapping Between Different Error Types</a></li>
<li><a href="#errors_are_not_implementation_details">Critique 3: LEAF Does Not Treat Low Level Error Types as Implementation Details</a></li>
</ul>
</li>
<li><a href="#_alternatives_to_leaf">Alternatives to LEAF</a>
<ul class="sectlevel2">
<li><a href="#boost_exception">Comparison to Boost Exception</a></li>
<li><a href="#boost_outcome">Comparison to Boost Outcome</a>
<ul class="sectlevel3">
<li><a href="#_design_differences">Design Differences</a></li>
<li><a href="#interoperability">The Interoperability Problem</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#_benchmark">Benchmark</a></li>
<li><a href="#_running_the_unit_tests">Running the Unit Tests</a>
<ul class="sectlevel2">
<li><a href="#_meson_build">Meson Build</a></li>
<li><a href="#_boost_build">Boost Build</a></li>
</ul>
</li>
<li><a href="#_configuration_macros">Configuration Macros</a></li>
<li><a href="#_acknowledgements">Acknowledgements</a></li>
</ul>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph text-right">
<p><a href="https://github.com/boostorg/leaf">GitHub</a> | <a href="./leaf.pdf">PDF</a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_abstract">Abstract</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Boost LEAF is a lightweight error handling library for C++11. Features:</p>
</div>
<div class="exampleblock">
<div class="content">
<div class="ulist">
<ul>
<li>
<p>Small single-header format, no dependencies.</p>
</li>
<li>
<p>Designed for maximum efficiency ("happy" path and "sad" path).</p>
</li>
<li>
<p>No dynamic memory allocations, even with heavy payloads.</p>
</li>
<li>
<p>O(1) transport of arbitrary error types (independent of call stack depth).</p>
</li>
<li>
<p>Can be used with or without exception handling.</p>
</li>
<li>
<p>Support for multi-thread programming.</p>
</li>
</ul>
</div>
</div>
</div>
<table class="tableblock frame-none grid-none stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#introduction">Introduction</a> | <a href="#tutorial">Tutorial</a> | <a href="#synopsis">Synopsis</a> | <a href="https://github.com/boostorg/leaf/blob/master/doc/whitepaper.md">Whitepaper</a> | <a href="https://github.com/boostorg/leaf/blob/master/benchmark/benchmark.md">Benchmark</a></p></td>
<td class="tableblock halign-right valign-top"><p class="tableblock">Reference: <a href="#functions">Functions</a> | <a href="#types">Types</a> | <a href="#predicates">Predicates</a> | <a href="#traits">Traits</a> | <a href="#macros">Macros</a></p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<p>LEAF is designed with a strong bias towards the common use case where callers of functions which may fail check for success and forward errors up the call stack but do not handle them. In this case, only a trivial success-or-failure discriminant is transported. Actual error objects are communicated directly to the error-handling scope, skipping the intermediate check-only frames altogether.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="support">Support</h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="https://Cpplang.slack.com">cpplang on Slack</a> (use the <code>#boost</code> channel)</p>
</li>
<li>
<p><a href="https://lists.boost.org/mailman/listinfo.cgi/boost-users">Boost Users Mailing List</a></p>
</li>
<li>
<p><a href="https://lists.boost.org/mailman/listinfo.cgi/boost">Boost Developers Mailing List</a></p>
</li>
<li>
<p><a href="https://github.com/boostorg/leaf/issues">Report an issue</a> on GitHub</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="distribution">Distribution and Portability</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p>
</div>
<div class="paragraph">
<p>LEAF requires only C++11 (including support for thread-local storage).</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="introduction">Five Minute Introduction</h2>
<div class="sectionbody">
<div class="paragraph">
<p>We’ll implement two versions of the same simple program: one using the LEAF <code>noexcept</code> API to handle errors, and another using the exception-handling API.</p>
</div>
<div class="sect2">
<h3 id="introduction-result"><code>noexcept</code> API</h3>
<div class="paragraph">
<p>We’ll write a short but complete program that reads a text file in a buffer and prints it to <code>std::cout</code>, using LEAF to handle errors without exception handling.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
LEAF provides an <a href="#introduction-eh">Exception-Handling API</a> as well.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>We’ll skip to the chase and start with the <code>main</code> function: it will try several operations as needed and handle all the errors that occur. Did I say <strong>all</strong> the errors? I did, so we’ll use <code>leaf::try_handle_all</code>. It has the following signature:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">template <class TryBlock, class... Handler>
<<deduced>> try_handle_all( TryBlock && try_block, Handler && ... handler );</code></pre>
</div>
</div>
<div class="paragraph">
<p><code>TryBlock</code> is a function type, required to return a <code>result<T></code> — for example, <code>leaf::result<T></code> — that holds a value of type <code>T</code> or else indicates a failure.</p>
</div>
<div class="paragraph">
<p>The first thing <code>try_handle_all</code> does is invoke the <code>try_block</code> function. If the returned object <code>r</code> indicates success, <code>try_handle_all</code> unwraps it, returning the contained <code>r.value()</code>; otherwise it calls the <span class="underline">first suitable</span> error handling function from the <code>handler…​</code> list.</p>
</div>
<div class="paragraph">
<p>We’ll see later just what kind of a <code>TryBlock</code> will our <code>main</code> function pass to <code>try_handle_all</code>, but first, let’s look at the juicy error-handling part. In case of an error, LEAF will consider each of the error handlers, <span class="underline">in order</span>, and call the first suitable match:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">int main( int argc, char const * argv[] )
{
return leaf::try_handle_all(
[&]() -> leaf::result<int>
{
// The TryBlock goes here, we'll see it later
},
// Error handlers below:
[](leaf::match<error_code, open_error>, leaf::match_value<leaf::e_errno, ENOENT>, leaf::e_file_name const & fn)
{ <i class="conum" data-value="1"></i><b>(1)</b>
std::cerr << "File not found: " << fn.value << std::endl;
return 1;
},
[](leaf::match<error_code, open_error>, leaf::e_errno const & errn, leaf::e_file_name const & fn)
{ <i class="conum" data-value="2"></i><b>(2)</b>
std::cerr << "Failed to open " << fn.value << ", errno=" << errn << std::endl;
return 2;
},
[](leaf::match<error_code, size_error, read_error, eof_error>, leaf::e_errno const * errn, leaf::e_file_name const & fn)
{ <i class="conum" data-value="3"></i><b>(3)</b>
std::cerr << "Failed to access " << fn.value;
if( errn )
std::cerr << ", errno=" << *errn;
std::cerr << std::endl;
return 3;
},
[](leaf::match<error_code, output_error>, leaf::e_errno const & errn)
{ <i class="conum" data-value="4"></i><b>(4)</b>
std::cerr << "Output error, errno=" << errn << std::endl;
return 4;
},
[](leaf::match<error_code, bad_command_line>)
{ <i class="conum" data-value="5"></i><b>(5)</b>
std::cout << "Bad command line argument" << std::endl;
return 5;
},
[](leaf::error_info const & unmatched)
{ <i class="conum" data-value="6"></i><b>(6)</b>
std::cerr <<
"Unknown failure detected" << std::endl <<
"Cryptic diagnostic information follows" << std::endl <<
unmatched;
return 6;
}
);
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>This handler will be called if the detected error includes:<br>
• an object of type <code>enum error_code</code> equal to the value <code>open_error</code>, and<br>
• an object of type <code>leaf::e_errno</code> that has <code>.value</code> equal to <code>ENOENT</code>, and<br>
• an object of type <code>leaf::e_file_name</code>.<br>
In short, it handles "file not found" errors.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>This handler will be called if the detected error includes:<br>
• an object of type <code>enum error_code</code> equal to <code>open_error</code>, and<br>
• an object of type <code>leaf::e_errno</code> (regardless of its <code>.value</code>), and<br>
• an object of type <code>leaf::e_file_name</code>.<br>
In short, it will handle other "file open" errors.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>This handler will be called if the detected error includes:<br>
• an object of type <code>enum error_code</code> equal to any of <code>size_error</code>, <code>read_error</code>, <code>eof_error</code>, and<br>
• an optional object of type <code>leaf::e_errno</code> (regardless of its <code>.value</code>), and<br>
• an object of type <code>leaf::e_file_name</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>This handler will be called if the detected error includes:<br>
• an object of type <code>enum error_code</code> equal to <code>output_error</code>, and<br>
• an object of type <code>leaf::e_errno</code> (regardless of its <code>.value</code>),</td>
</tr>
<tr>
<td><i class="conum" data-value="5"></i><b>5</b></td>
<td>This handler will be called if the detected error includes an object of type <code>enum error_code</code> equal to <code>bad_command_line</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="6"></i><b>6</b></td>
<td>This last handler is a catch-all for any error, in case no other handler could be selected: it prints diagnostic information to help debug logic errors in the program, since it failed to find an appropriate error handler for the error condition it encountered.</td>
</tr>
</table>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
It is critical to understand that the error handlers are considered in order, rather than by finding a "best match". No error handler is "better" than the others: LEAF will call the first one for which all of the arguments can be supplied using the available error objects.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Now, reading and printing a file may not seem like a complex job, but let’s split it into several functions, each communicating failures using <code>leaf::result<T></code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<char const *> parse_command_line( int argc, char const * argv[] ) noexcept; <i class="conum" data-value="1"></i><b>(1)</b>
leaf::result<std::shared_ptr<FILE>> file_open( char const * file_name ) noexcept; <i class="conum" data-value="2"></i><b>(2)</b>
leaf::result<int> file_size( FILE & f ) noexcept; <i class="conum" data-value="3"></i><b>(3)</b>
leaf::result<void> file_read( FILE & f, void * buf, int size ) noexcept; <i class="conum" data-value="4"></i><b>(4)</b></code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Parse the command line, return the file name.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Open a file for reading.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Return the size of the file.</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>Read size bytes from f into buf.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>For example, let’s look at <code>file_open</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<std::shared_ptr<FILE>> file_open( char const * file_name ) noexcept
{
if( FILE * f = fopen(file_name,"rb") )
return std::shared_ptr<FILE>(f,&fclose);
else
return leaf::new_error(open_error, leaf::e_errno{errno});
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>If <code>fopen</code> succeeds, we return a <code>shared_ptr</code> which will automatically call <code>fclose</code> as needed. If <code>fopen</code> fails, we report an error by calling <code>new_error</code>, which takes any number of error objects to communicate with the error. In this case we pass the system <code>errno</code> (LEAF defines <code>struct e_errno {int value;}</code>), and our own error code value, <code>open_error</code>.</p>
</div>
<div class="paragraph">
<p>Here is our complete error code <code>enum</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum error_code
{
bad_command_line = 1,
open_error,
read_error,
size_error,
eof_error,
output_error
};</code></pre>
</div>
</div>
<div class="paragraph">
<p>We’re now ready to look at the <code>TryBlock</code> we’ll pass to <code>try_handle_all</code>. It does all the work, bails out if it encounters an error:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">int main( int argc, char const * argv[] )
{
return leaf::try_handle_all(
[&]() -> leaf::result<int>
{
leaf::result<char const *> file_name = parse_command_line(argc,argv);
if( !file_name )
return file_name.error();</code></pre>
</div>
</div>
<div class="paragraph">
<p>Wait, what’s this, if "error" return "error"? There is a better way: we’ll use <code>BOOST_LEAF_AUTO</code>. It takes a <code>result<T></code> and bails out in case of a failure (control leaves the calling function), otherwise uses the passed variable to access the <code>T</code> value stored in the <code>result</code> object.</p>
</div>
<div class="paragraph">
<p>This is what our <code>TryBlock</code> really looks like:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">int main( int argc, char const * argv[] )
{
return leaf::try_handle_all(
[&]() -> leaf::result<int> <i class="conum" data-value="1"></i><b>(1)</b>
{
BOOST_LEAF_AUTO(file_name, parse_command_line(argc,argv)); <i class="conum" data-value="2"></i><b>(2)</b>
auto load = leaf::on_error( leaf::e_file_name{file_name} ); <i class="conum" data-value="3"></i><b>(3)</b>
BOOST_LEAF_AUTO(f, file_open(file_name)); <i class="conum" data-value="4"></i><b>(4)</b>
BOOST_LEAF_AUTO(s, file_size(*f)); <i class="conum" data-value="4"></i><b>(4)</b>
std::string buffer( 1 + s, '\0' );
BOOST_LEAF_CHECK(file_read(*f, &buffer[0], buffer.size()-1)); <i class="conum" data-value="4"></i><b>(4)</b>
std::cout << buffer;
std::cout.flush();
if( std::cout.fail() )
return leaf::new_error(output_error, leaf::e_errno{errno});
return 0;
},
.... <i class="conum" data-value="5"></i><b>(5)</b>
); <i class="conum" data-value="6"></i><b>(6)</b>
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Our <code>TryBlock</code> returns a <code>result<int></code>. In case of success, it will hold <code>0</code>, which will be returned from <code>main</code> to the OS.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>If <code>parse_command_line</code> returns an error, we forward that error to <code>try_handle_all</code> (which invoked us) verbatim. Otherwise, <code>BOOST_LEAF_AUTO</code> gets us a variable, <code>file_name</code>, to access the parsed string.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>From now on, all errors escaping this scope will automatically communicate the (now successfully parsed from the command line) file name (LEAF defines <code>struct e_file_name {std::string value;}</code>). This is as if every time one of the following functions wants to report an error, <code>on_error</code> says "wait, associate this <code>e_file_name</code> object with the error, it’s important!"</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>Call more functions, forward each failure to the caller.</td>
</tr>
<tr>
<td><i class="conum" data-value="5"></i><b>5</b></td>
<td>List of error handlers goes here (we saw this earlier).</td>
</tr>
<tr>
<td><i class="conum" data-value="6"></i><b>6</b></td>
<td>This concludes the <code>try_handle_all</code> arguments — as well as our program!</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Nice and simple! Writing the <code>TryBlock</code>, we focus on the "happy" path — if we encounter any error we just return it to <code>try_handle_all</code> for processing. Well, that’s if we’re being good and using RAII for automatic clean-up — which we are, <code>shared_ptr</code> will automatically close the file for us.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
The complete program from this tutorial is available <a href="https://github.com/boostorg/leaf/blob/master/examples/print_file/print_file_result.cpp?ts=4">here</a>. The <a href="https://github.com/boostorg/leaf/blob/master/examples/print_file/print_file_eh.cpp?ts=4">other</a> version of the same program uses exception handling to report errors (see <a href="#introduction-eh">below</a>).
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="introduction-eh">Exception-Handling API</h3>
<div class="paragraph">
<p>And now, we’ll write the same program that reads a text file in a buffer and prints it to <code>std::cout</code>, this time using exceptions to report errors. First, we need to define our exception class hierarchy:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct bad_command_line: std::exception { };
struct input_error: std::exception { };
struct open_error: input_error { };
struct read_error: input_error { };
struct size_error: input_error { };
struct eof_error: input_error { };
struct output_error: std::exception { };</code></pre>
</div>
</div>
<div class="paragraph">
<p>We’ll split the job into several functions, communicating failures by throwing exceptions:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">char const * parse_command_line( int argc, char const * argv[] ); <i class="conum" data-value="1"></i><b>(1)</b>
std::shared_ptr<FILE> file_open( char const * file_name ); <i class="conum" data-value="2"></i><b>(2)</b>
int file_size( FILE & f ); <i class="conum" data-value="3"></i><b>(3)</b>
void file_read( FILE & f, void * buf, int size ); <i class="conum" data-value="4"></i><b>(4)</b></code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Parse the command line, return the file name.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Open a file for reading.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Return the size of the file.</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>Read size bytes from f into buf.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The <code>main</code> function brings everything together and handles all the exceptions that are thrown, but instead of using <code>try</code> and <code>catch</code>, it will use the function template <code>leaf::try_catch</code>, which has the following signature:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">template <class TryBlock, class... Handler>
<<deduced>> try_catch( TryBlock && try_block, Handler && ... handler );</code></pre>
</div>
</div>
<div class="paragraph">
<p><code>TryBlock</code> is a function type that takes no arguments; <code>try_catch</code> simply returns the value returned by the <code>try_block</code>, catching <span class="underline">any</span> exception it throws, in which case it calls the <span class="underline">first</span> suitable error handling function from the <code>handler…​</code> list.</p>
</div>
<div class="paragraph">
<p>Let’s first look at the <code>TryBlock</code> our <code>main</code> function passes to <code>try_catch</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">int main( int argc, char const * argv[] )
{
return leaf::try_catch(
[&] <i class="conum" data-value="1"></i><b>(1)</b>
{
char const * file_name = parse_command_line(argc,argv); <i class="conum" data-value="2"></i><b>(2)</b>
auto load = leaf::on_error( leaf::e_file_name{file_name} ); <i class="conum" data-value="3"></i><b>(3)</b>
std::shared_ptr<FILE> f = file_open( file_name ); <i class="conum" data-value="2"></i><b>(2)</b>
std::string buffer( 1+file_size(*f), '\0' ); <i class="conum" data-value="2"></i><b>(2)</b>
file_read(*f, &buffer[0], buffer.size()-1); <i class="conum" data-value="2"></i><b>(2)</b>
std::cout << buffer;
std::cout.flush();
if( std::cout.fail() )
throw leaf::exception(output_error{}, leaf::e_errno{errno});
return 0;
},
.... <i class="conum" data-value="4"></i><b>(4)</b>
); <i class="conum" data-value="5"></i><b>(5)</b>
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Except if it throws, our <code>TryBlock</code> returns <code>0</code>, which will be returned from <code>main</code> to the OS.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>If any of the functions we call throws, <code>try_catch</code> will find an appropriate handler to invoke (below).</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>From now on, all exceptions escaping this scope will automatically communicate the (now successfully parsed from the command line) file name (LEAF defines <code>struct e_file_name {std::string value;}</code>). This is as if every time one of the following functions wants to throw an exception, <code>on_error</code> says "wait, associate this <code>e_file_name</code> object with the exception, it’s important!"</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>List of error handlers goes here. We’ll see that later.</td>
</tr>
<tr>
<td><i class="conum" data-value="5"></i><b>5</b></td>
<td>This concludes the <code>try_catch</code> arguments — as well as our program!</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>As it is always the case when using exception handling, as long as our <code>TryBlock</code> is exception-safe, we can focus on the "happy" path. Of course, our <code>TryBlock</code> is exception-safe, since <code>shared_ptr</code> will automatically close the file for us in case an exception is thrown.</p>
</div>
<div class="paragraph">
<p>Now let’s look at the second part of the call to <code>try_catch</code>, which lists the error handlers:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">int main( int argc, char const * argv[] )
{
return leaf::try_catch(
[&]
{
// The TryBlock goes here (we saw that earlier)
},
// Error handlers below:
[](open_error &, leaf::match_value<leaf::e_errno,ENOENT>, leaf::e_file_name const & fn)
{ <i class="conum" data-value="1"></i><b>(1)</b>
std::cerr << "File not found: " << fn.value << std::endl;
return 1;
},
[](open_error &, leaf::e_file_name const & fn, leaf::e_errno const & errn)
{ <i class="conum" data-value="2"></i><b>(2)</b>
std::cerr << "Failed to open " << fn.value << ", errno=" << errn << std::endl;
return 2;
},
[](input_error &, leaf::e_errno const * errn, leaf::e_file_name const & fn)
{ <i class="conum" data-value="3"></i><b>(3)</b>
std::cerr << "Failed to access " << fn.value;
if( errn )
std::cerr << ", errno=" << *errn;
std::cerr << std::endl;
return 3;
},
[](output_error &, leaf::e_errno const & errn)
{ <i class="conum" data-value="4"></i><b>(4)</b>
std::cerr << "Output error, errno=" << errn << std::endl;
return 4;
},
[](bad_command_line &)
{ <i class="conum" data-value="5"></i><b>(5)</b>
std::cout << "Bad command line argument" << std::endl;
return 5;
},
[](leaf::error_info const & unmatched)
{ <i class="conum" data-value="6"></i><b>(6)</b>
std::cerr <<
"Unknown failure detected" << std::endl <<
"Cryptic diagnostic information follows" << std::endl <<
unmatched;
return 6;
} );
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>This handler will be called if:<br>
• an <code>open_error</code> exception was caught, with<br>
• an object of type <code>leaf::e_errno</code> that has <code>.value</code> equal to <code>ENOENT</code>, and<br>
• an object of type <code>leaf::e_file_name</code>.<br>
In short, it handles "file not found" errors.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>This handler will be called if:<br>
• an <code>open_error</code> exception was caught, with<br>
• an object of type <code>leaf::e_errno</code> (regardless of its <code>.value</code>), and<br>
• an object of type <code>leaf::e_file_name</code>.<br>
In short, it handles other "file open" errors.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>This handler will be called if:<br>
• an <code>input_error</code> exception was caught (which is a base type), with<br>
• an optional object of type <code>leaf::e_errno</code> (regardless of its <code>.value</code>), and<br>
• an object of type <code>leaf::e_file_name</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>This handler will be called if:<br>
• an <code>output_error</code> exception was caught, with<br>
• an object of type <code>leaf::e_errno</code> (regardless of its <code>.value</code>),</td>
</tr>
<tr>
<td><i class="conum" data-value="5"></i><b>5</b></td>
<td>This handler will be called if a <code>bad_command_line</code> exception was caught.</td>
</tr>
<tr>
<td><i class="conum" data-value="6"></i><b>6</b></td>
<td>If <code>try_catch</code> fails to find an appropriate handler, it will re-throw the exception. But this is the <code>main</code> function which should handle all exceptions, so this last handler matches any error and prints diagnostic information, to help debug logic errors.</td>
</tr>
</table>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
It is critical to understand that the error handlers are considered in order, rather than by finding a "best match". No error handler is "better" than the others: LEAF will call the first one for which all of the arguments can be supplied using the available error objects.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>To conclude this introduction, let’s look at one of the error-reporting functions that our <code>TryBlock</code> calls, for example <code>file_open</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">std::shared_ptr<FILE> file_open( char const * file_name )
{
if( FILE * f = fopen(file_name,"rb") )
return std::shared_ptr<FILE>(f,&fclose);
else
throw leaf::exception(open_error{}, leaf::e_errno{errno});
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>If <code>fopen</code> succeeds, it returns a <code>shared_ptr</code> which will automatically call <code>fclose</code> as needed. If <code>fopen</code> fails, we throw the exception object returned by <code>leaf::exception</code>, which in this case is of type that derives from <code>open_error</code>; the passed <code>e_errno</code> object will be associated with the exception.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<code>try_catch</code> works with any exception, not only exceptions thrown using <code>leaf::exception</code>.
</td>
</tr>
</table>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
The complete program from this tutorial is available <a href="https://github.com/boostorg/leaf/blob/master/examples/print_file/print_file_eh.cpp?ts=4">here</a>. The <a href="https://github.com/boostorg/leaf/blob/master/examples/print_file/print_file_result.cpp?ts=4">other</a> version of the same program does not use exception handling to report errors (see the <a href="#introduction-result">previous introduction</a>).
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="tutorial">Tutorial</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This section assumes the reader has basic understanding of using LEAF to handle errors; see <a href="#introduction">Five Minute Introduction</a>.</p>
</div>
<div class="sect2">
<h3 id="tutorial-model">Error Communication Model</h3>
<div class="sect3">
<h4 id="_noexcept_api"><code>noexcept</code> API</h4>
<div class="paragraph">
<p>The following figure illustrates how error objects are transported when using LEAF without exception handling:</p>
</div>
<div class="imageblock">
<div class="content">
<img src="LEAF-1.png" alt="LEAF 1">
</div>
<div class="title">Figure 1. LEAF noexcept Error Communication Model</div>
</div>
<div class="paragraph">
<p>The arrows pointing down indicate the call stack order for the functions <code>f1</code> through <code>f5</code>: higher level functions calling lower level functions.</p>
</div>
<div class="paragraph">
<p>Note the call to <code>on_error</code> in <code>f3</code>: it caches the passed error objects of types <code>E1</code> and <code>E3</code> in the returned object <code>load</code>, where they stay ready to be communicated in case any function downstream from <code>f3</code> reports an error. Presumably these objects are relevant to any such failure, but are conveniently accessible only in this scope.</p>
</div>
<div class="paragraph">
<p><em>Figure 1</em> depicts the condition where <code>f5</code> has detected an error. It calls <code>leaf::new_error</code> to create a new, unique <code>error_id</code>. The passed error object of type <code>E2</code> is immediately loaded in the first active <code>context</code> object that provides static storage for it, found in any calling scope (in this case <code>f1</code>), and is associated with the newly-generated <code>error_id</code> (solid arrow);</p>
</div>
<div class="paragraph">
<p>The <code>error_id</code> itself is returned to the immediate caller <code>f4</code>, usually stored in a <code>result<T></code> object <code>r</code>. That object takes the path shown by dashed arrows, as each error-neutral function, unable to handle the failure, forwards it to its immediate caller in the returned value — until an error-handling scope is reached.</p>
</div>
<div class="paragraph">
<p>When the destructor of the <code>load</code> object in <code>f3</code> executes, it detects that <code>new_error</code> was invoked after its initialization, loads the cached objects of types <code>E1</code> and <code>E3</code> in the first active <code>context</code> object that provides static storage for them, found in any calling scope (in this case <code>f1</code>), and associates them with the last generated <code>error_id</code> (solid arrow).</p>
</div>
<div class="paragraph">
<p>When the error-handling scope <code>f1</code> is reached, it probes <code>ctx</code> for any error objects associated with the <code>error_id</code> it received from <code>f2</code>, and processes a list of user-provided error handlers, in order, until it finds a handler with arguments that can be supplied using the available (in <code>ctx</code>) error objects. That handler is called to deal with the failure.</p>
</div>
</div>
<div class="sect3">
<h4 id="_exception_handling_api">Exception-Handling API</h4>
<div class="paragraph">
<p>The following figure illustrates the slightly different error communication model used when errors are reported by throwing exceptions:</p>
</div>
<div class="imageblock">
<div class="content">
<img src="LEAF-2.png" alt="LEAF 2">
</div>
<div class="title">Figure 2. LEAF Error Communication Model Using Exception Handling</div>
</div>
<div class="paragraph">
<p>The main difference is that the call to <code>new_error</code> is implicit in the call to the function template <code>leaf::exception</code>, which in this case takes an exception object of type <code>Ex</code>, and returns an exception object of unspecified type that derives publicly from <code>Ex</code>.</p>
</div>
</div>
<div class="sect3">
<h4 id="tutorial-interoperability">Interoperability</h4>
<div class="paragraph">
<p>Ideally, when an error is detected, a program using LEAF would always call <a href="#new_error"><code>new_error</code></a>, ensuring that each encountered failure is definitely assigned a unique <a href="#error_id"><code>error_id</code></a>, which then is reliably delivered, by an exception or by a <code>result<T></code> object, to the appropriate error-handling scope.</p>
</div>
<div class="paragraph">
<p>Alas, this is not always possible.</p>
</div>
<div class="paragraph">
<p>For example, the error may need to be communicated through uncooperative 3rd-party interfaces. To facilitate this transmission, a error ID may be encoded in a <code>std::error_code</code>. As long as a 3rd-party interface understands <code>std::error_code</code>, it should be compatible with LEAF.</p>
</div>
<div class="paragraph">
<p>Further, it is sometimes necessary to communicate errors through an interface that does not even use <code>std::error_code</code>. An example of this is when an external lower-level library throws an exception, which is unlikely to be able to carry an <code>error_id</code>.</p>
</div>
<div class="paragraph">
<p>To support this tricky use case, LEAF provides the function <a href="#current_error"><code>current_error</code></a>, which returns the error ID returned by the most recent call (from this thread) to <a href="#new_error"><code>new_error</code></a>. One possible approach to solving the problem is to use the following logic (implemented by the <a href="#error_monitor"><code>error_monitor</code></a> type):</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Before calling the uncooperative API, call <a href="#current_error"><code>current_error</code></a> and cache the returned value.</p>
</li>
<li>
<p>Call the API, then call <code>current_error</code> again:</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>If this returns the same value as before, pass the error objects to <code>new_error</code> to associate them with a new <code>error_id</code>;</p>
</li>
<li>
<p>else, associate the error objects with the <code>error_id</code> value returned by the second call to <code>current_error</code>.</p>
</li>
</ol>
</div>
</li>
</ol>
</div>
<div class="paragraph">
<p>Note that if the above logic is nested (e.g. one function calling another), <code>new_error</code> will be called only by the inner-most function, because that call guarantees that all calling functions will hit the <code>else</code> branch.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
To avoid ambiguities, whenever possible, use the <a href="#exception"><code>exception</code></a> function template when throwing exceptions to ensure that the exception object transports a unique <code>error_id</code>; better yet, use the <a href="#BOOST_LEAF_THROW_EXCEPTION"><code>BOOST_LEAF_THROW_EXCEPTION</code></a> macro, which in addition will capture <code>__FILE__</code> and <code>__LINE__</code>.
</td>
</tr>
</table>
</div>
<hr>
</div>
</div>
<div class="sect2">
<h3 id="tutorial-loading">Loading of Error Objects</h3>
<div class="paragraph">
<p>To load an error object is to move it into an active <a href="#context"><code>context</code></a>, usually local to a <a href="#try_handle_some"><code>try_handle_some</code></a>, a <a href="#try_handle_all"><code>try_handle_all</code></a> or a <a href="#try_catch"><code>try_catch</code></a> scope in the calling thread, where it becomes uniquely associated with a specific <a href="#error_id"><code>error_id</code></a> — or discarded if storage is not available.</p>
</div>
<div class="paragraph">
<p>Various LEAF functions take a list of error objects to load. As an example, if a function <code>copy_file</code> that takes the name of the input file and the name of the output file as its arguments detects a failure, it could communicate an error code <code>ec</code>, plus the two relevant file names using <a href="#new_error"><code>new_error</code></a>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">return leaf::new_error(ec, e_input_name{n1}, e_output_name{n2});</code></pre>
</div>
</div>
<div class="paragraph">
<p>Alternatively, error objects may be loaded using a <code>result<T></code> that is already communicating an error. This way they become associated with that error, rather than with a new error:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<int> f() noexcept;
leaf::result<void> g( char const * fn ) noexcept
{
if( leaf::result<int> r = f() )
{ <i class="conum" data-value="1"></i><b>(1)</b>
....;
return { };
}
else
{
return r.load( e_file_name{fn} ); <i class="conum" data-value="2"></i><b>(2)</b>
}
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#result::load"><code>load</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Success! Use <code>r.value()</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td><code>f()</code> has failed; here we associate an additional <code>e_file_name</code> with the error. However, this association occurs iff in the call stack leading to <code>g</code> there are error handlers that take an <code>e_file_name</code> argument. Otherwise, the object passed to <code>load</code> is discarded. In other words, the passed objects are loaded iff the program actually uses them to handle errors.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Besides error objects, <code>load</code> can take function arguments:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>If we pass a function that takes no arguments, it is invoked, and the returned error object is loaded.</p>
<div class="paragraph">
<p>Consider that if we pass to <code>load</code> an error object that is not needed by any error handler, it will be discarded. If the object is expensive to compute, it would be better if the computation can be skipped as well. Passing a function with no arguments to <code>load</code> is an excellent way to achieve this behavior:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct info { .... };
info compute_info() noexcept;
leaf::result<void> operation( char const * file_name ) noexcept
{
if( leaf::result<int> r = try_something() )
{ <i class="conum" data-value="1"></i><b>(1)</b>
....
return { };
}
else
{
return r.load( <i class="conum" data-value="2"></i><b>(2)</b>
[&]
{
return compute_info();
} );
}
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#result::load"><code>load</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Success! Use <code>r.value()</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td><code>try_something</code> has failed; <code>compute_info</code> will only be called if an error handler exists which takes a <code>info</code> argument.</td>
</tr>
</table>
</div>
</li>
<li>
<p>If we pass a function that takes a single argument of type <code>E &</code>, LEAF calls the function with the object of type <code>E</code> currently loaded in an active <code>context</code>, associated with the error. If no such object is available, a new one is default-initialized and then passed to the function.</p>
<div class="paragraph">
<p>For example, if an operation that involves many different files fails, a program may provide for collecting all relevant file names in a <code>e_relevant_file_names</code> object:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct e_relevant_file_names
{
std::vector<std::string> value;
};
leaf::result<void> operation( char const * file_name ) noexcept
{
if( leaf::result<int> r = try_something() )
{ <i class="conum" data-value="1"></i><b>(1)</b>
....
return { };
}
else
{
return r.load( <i class="conum" data-value="2"></i><b>(2)</b>
[&](e_relevant_file_names & e)
{
e.value.push_back(file_name);
} );
}
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#result::load"><code>load</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Success! Use <code>r.value()</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td><code>try_something</code> has failed — add <code>file_name</code> to the <code>e_relevant_file_names</code> object, associated with the <code>error_id</code> communicated in <code>r</code>. Note, however, that the passed function will only be called iff in the call stack there are error handlers that take an <code>e_relevant_file_names</code> object.</td>
</tr>
</table>
</div>
</li>
</ul>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="tutorial-on_error">Using <code>on_error</code></h3>
<div class="paragraph">
<p>It is not typical for an error-reporting function to be able to supply all of the data needed by a suitable error-handling function in order to recover from the failure. For example, a function that reports <code>FILE</code> operation failures may not have access to the file name, yet an error handling function needs it in order to print a useful error message.</p>
</div>
<div class="paragraph">
<p>Of course the file name is typically readily available in the call stack leading to the failed <code>FILE</code> operation. Below, while <code>parse_info</code> can’t report the file name, <code>parse_file</code> can and does:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<info> parse_info( FILE * f ) noexcept; <i class="conum" data-value="1"></i><b>(1)</b>
leaf::result<info> parse_file( char const * file_name ) noexcept
{
auto load = leaf::on_error(leaf::e_file_name{file_name}); <i class="conum" data-value="2"></i><b>(2)</b>
if( FILE * f = fopen(file_name,"r") )
{
auto r = parse_info(f);
fclose(f);
return r;
}
else
return leaf::new_error( error_enum::file_open_error );
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#on_error"><code>on_error</code></a> | <a href="#new_error"><code>new_error</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td><code>parse_info</code> parses <code>f</code>, communicating errors using <code>result<info></code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Using <code>on_error</code> ensures that the file name is included with any error reported out of <code>parse_file</code>. All we need to do is hold on to the returned object <code>load</code>; when it expires, if an error is being reported, the passed <code>e_file_name</code> value will be automatically associated with it.</td>
</tr>
</table>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<code>on_error</code> —  like <code>load</code> — can be passed any number of arguments.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>When we invoke <code>on_error</code>, we can pass three kinds of arguments:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Actual error objects (like in the example above);</p>
</li>
<li>
<p>Functions that take no arguments and return an error object;</p>
</li>
<li>
<p>Functions that take an error object by mutable reference.</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>If we want to use <code>on_error</code> to capture <code>errno</code>, we can’t just pass <a href="#e_errno"><code>e_errno</code></a> to it, because at that time it hasn’t been set (yet). Instead, we’d pass a function that returns it:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">void read_file(FILE * f) {
auto load = leaf::on_error([]{ return e_errno{errno}; });
....
size_t nr1=fread(buf1,1,count1,f);
if( ferror(f) )
throw leaf::exception();
size_t nr2=fread(buf2,1,count2,f);
if( ferror(f) )
throw leaf::exception();
size_t nr3=fread(buf3,1,count3,f);
if( ferror(f) )
throw leaf::exception();
....
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>Above, if a <code>throw</code> statement is reached, LEAF will invoke the function passed to <code>on_error</code> and associate the returned <code>e_errno</code> object with the exception.</p>
</div>
<div class="paragraph">
<p>The final type of arguments that can be passed to <code>on_error</code> is a function that takes a single mutable error object reference. In this case, <code>on_error</code> uses it similarly to how such functios are used by <code>load</code>; see <a href="#tutorial-loading">Loading of Error Objects</a>.</p>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="tutorial-predicates">Using Predicates to Handle Errors</h3>
<div class="paragraph">
<p>Usually, LEAF error handlers are selected based on the type of the arguments they take and the type of the available error objects. When an error handler takes a predicate type as an argument, the <a href="#handler_selection_procedure">handler selection procedure</a> is able to also take into account the <em>value</em> of the available error objects.</p>
</div>
<div class="paragraph">
<p>Consider this error code enum:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum class my_error
{
e1=1,
e2,
e3
};</code></pre>
</div>
</div>
<div class="paragraph">
<p>We could handle <code>my_error</code> errors like so:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">return leaf::try_handle_some(
[]
{
return f(); // returns leaf::result<T>
},
[]( my_error e )
{ <i class="conum" data-value="1"></i><b>(1)</b>
switch(e)
{
case my_error::e1:
....; <i class="conum" data-value="2"></i><b>(2)</b>
break;
case my_error::e2:
case my_error::e3:
....; <i class="conum" data-value="3"></i><b>(3)</b>
break;
default:
....; <i class="conum" data-value="4"></i><b>(4)</b>
break;
} );</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>This handler will be selected if we’ve got a <code>my_error</code> object.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Handle <code>e1</code> errors.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Handle <code>e2</code> and <code>e3</code> errors.</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>Handle bad <code>my_error</code> values.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>If <code>my_error</code> object is available, LEAF will call our error handler. If not, the failure will be forwarded to our caller.</p>
</div>
<div class="paragraph">
<p>This can be rewritten using the <a href="#match"><code>match</code></a> predicate to organize the different cases in different error handlers. The following is equivalent:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">return leaf::try_handle_some(
[]
{
return f(); // returns leaf::result<T>
},
[]( leaf::match<my_error, my_error::e1> m )
{ <i class="conum" data-value="1"></i><b>(1)</b>
assert(m.matched == my_error::e1);
....;
},
[]( leaf::match<my_error, my_error::e2, my_error::e3> m )
{ <i class="conum" data-value="2"></i><b>(2)</b>
assert(m.matched == my_error::e2 || m.matched == my_error::e3);
....;
},
[]( my_error e )
{ <i class="conum" data-value="3"></i><b>(3)</b>
....;
} );</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>We’ve got a <code>my_error</code> object that compares equal to <code>e1</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>We`ve got a <code>my_error</code> object that compares equal to either <code>e2</code> or <code>e3</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Handle bad <code>my_error</code> values.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The first argument to the <code>match</code> template generally specifies the type <code>E</code> of the error object <code>e</code> that must be available for the error handler to be considered at all. Typically, the rest of the arguments are values. The error handler to be dropped if <code>e</code> does not compare equal to any of them.</p>
</div>
<div class="paragraph">
<p>In particular, <code>match</code> works great with <code>std::error_code</code>. The following handler is designed to handle <code>ENOENT</code> errors:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">[]( leaf::match<std::error_code, std::errc::no_such_file_or_directory> )
{
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>This, however, requires C++17 or newer, because it is impossible to infer the type of the error enum (in this case, <code>std::errc</code>) from the specified type <code>std::error_code</code>, and C++11 does not allow <code>auto</code> template arguments. LEAF provides the following workaround, compatible with C++11:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">[]( leaf::match<leaf::condition<std::errc>, std::errc::no_such_file_or_directory> )
{
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>In addition, it is possible to select a handler based on <code>std::error_category</code>. The following handler will match any <code>std::error_code</code> of the <code>std::generic_category</code> (requires C++17 or newer):</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">[]( std::error_code, leaf::category<std::errc>> )
{
}</code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
See <a href="#match"><code>match</code></a> for more examples.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The following predicates are available:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="#match"><code>match</code></a>: as described above.</p>
</li>
<li>
<p><a href="#match_value"><code>match_value</code></a>: where <code>match<E, V…​></code> compares the object <code>e</code> of type <code>E</code> with the values <code>V…​</code>, <code>match_value<E, V…​></code> compare <code>e.value</code> with the values <code>V…​</code>.</p>
</li>
<li>
<p><a href="#match_member"><code>match_member</code></a>: similar to <code>match_value</code>, but takes a pointer to the data member to compare; that is, <code>match_member<&E::value, V…​></code> is equvialent to <code>match_value<E, V…​></code>. Note, however, that <code>match_member</code> requires C++17 or newer, while <code>match_value</code> does not.</p>
</li>
<li>
<p><code><a href="#catch_">catch_</a><Ex…​></code>: Similar to <code>match</code>, but checks whether the caught <code>std::exception</code> object can be <code>dynamic_cast</code> to any of the <code>Ex</code> types.</p>
</li>
<li>
<p><a href="#if_not"><code>if_not</code></a> is a special predicate that takes any other predicate <code>Pred</code> and requires that an error object of type <code>E</code> is available and that <code>Pred</code> evaluates to <code>false</code>. For example, <code>if_not<match<E, V…​>></code> requires that an object <code>e</code> of type <code>E</code> is available, and that it does not compare equal to any of the specified <code>V…​</code>.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Finally, the predicate system is easily extensible, see <a href="#predicates">Predicates</a>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
See also <a href="#tutorial-std_error_code">Working with <code>std::error_code</code>, <code>std::error_condition</code></a>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="tutorial-binding_handlers">Binding Error Handlers in a <code>std::tuple</code></h3>
<div class="paragraph">
<p>Consider this snippet:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::try_handle_all(
[&]
{
return f(); // returns leaf::result<T>
},
[](my_error_enum x)
{
...
},
[](read_file_error_enum y, e_file_name const & fn)
{
...
},
[]
{
...
});</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#try_handle_all"><code>try_handle_all</code></a> | <a href="#e_file_name"><code>e_file_name</code></a></p>
</div>
<div class="paragraph">
<p>Looks pretty simple, but what if we need to attempt a different set of operations yet use the same handlers? We could repeat the same thing with a different function passed as <code>TryBlock</code> for <code>try_handle_all</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::try_handle_all(
[&]
{
return g(); // returns leaf::result<T>
},
[](my_error_enum x)
{
...
},
[](read_file_error_enum y, e_file_name const & fn)
{
...
},
[]
{
...
});</code></pre>
</div>
</div>
<div class="paragraph">
<p>That works, but it is better to bind our error handlers in a <code>std::tuple</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">auto error_handlers = std::make_tuple(
[](my_error_enum x)
{
...
},
[](read_file_error_enum y, e_file_name const & fn)
{
...
},
[]
{
...
});</code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>error_handlers</code> tuple can later be used with any error handling function:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::try_handle_all(
[&]
{
// Operations which may fail <i class="conum" data-value="1"></i><b>(1)</b>
},
error_handlers );
leaf::try_handle_all(
[&]
{
// Different operations which may fail <i class="conum" data-value="2"></i><b>(2)</b>
},
error_handlers ); <i class="conum" data-value="3"></i><b>(3)</b></code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#try_handle_all"><code>try_handle_all</code></a> | <a href="#error_info"><code>error_info</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>One set of operations which may fail…​</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>A different set of operations which may fail…​</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>…​ both using the same <code>error_handlers</code>.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Error-handling functions accept a <code>std::tuple</code> of error handlers in place of any error handler. The behavior is as if the tuple is unwrapped in-place.</p>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="tutorial-async">Transporting Error Objects Between Threads</h3>
<div class="paragraph">
<p>Error objects are stored on the stack in an instance of the <a href="#context"><code>context</code></a> class template in the scope of e.g. <a href="#try_handle_some"><code>try_handle_some</code></a>, <a href="#try_handle_all"><code>try_handle_all</code></a> or <a href="#try_catch"><code>try_catch</code></a> functions. When using concurrency, we need a mechanism to collect error objects in one thread, then use them to handle errors in another thread.</p>
</div>
<div class="paragraph">
<p>LEAF offers two interfaces for this purpose, one using <code>result<T></code>, and another designed for programs that use exception handling.</p>
</div>
<div class="sect3">
<h4 id="tutorial-async_result">Using <code>result<T></code></h4>
<div class="paragraph">
<p>Let’s assume we have a <code>task</code> that we want to launch asynchronously, which produces a <code>task_result</code> but could also fail:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<task_result> task();</code></pre>
</div>
</div>
<div class="paragraph">
<p>Because the task will run asynchronously, in case of a failure we need it to capture the relevant error objects but not handle errors. To this end, in the main thread we bind our error handlers in a <code>std::tuple</code>, which we will later use to handle errors from each completed asynchronous task (see <a href="#tutorial-binding_handlers">tutorial</a>):</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">auto error_handlers = std::make_tuple(
[](E1 e1, E2 e2)
{
//Deal with E1, E2
....
return { };
},
[](E3 e3)
{
//Deal with E3
....
return { };
} );</code></pre>
</div>
</div>
<div class="paragraph">
<p>Why did we start with this step? Because we need to create a <a href="#context"><code>context</code></a> object to collect the error objects we need. We could just instantiate the <code>context</code> template with <code>E1</code>, <code>E2</code> and <code>E3</code>, but that would be prone to errors, since it could get out of sync with the handlers we use. Thankfully LEAF can deduce the types we need automatically, we just need to show it our <code>error_handlers</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">std::shared_ptr<leaf::polymorphic_context> ctx = leaf::make_shared_context(error_handlers);</code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>polymorphic_context</code> type is an abstract base class that has the same members as any instance of the <code>context</code> class template, allowing us to erase its exact type. In this case what we’re holding in <code>ctx</code> is a <code>context<E1, E2, E3></code>, where <code>E1</code>, <code>E2</code> and <code>E3</code> were deduced automatically from the <code>error_handlers</code> tuple we passed to <code>make_shared_context</code>.</p>
</div>
<div class="paragraph">
<p>We’re now ready to launch our asynchronous task:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">std::future<leaf::result<task_result>> launch_task() noexcept
{
return std::async(
std::launch::async,
[&]
{
std::shared_ptr<leaf::polymorphic_context> ctx = leaf::make_shared_context(error_handlers);
return leaf::capture(ctx, &task);
} );
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#make_shared_context"><code>make_shared_context</code></a> | <a href="#capture"><code>capture</code></a></p>
</div>
<div class="paragraph">
<p>That’s it! Later when we <code>get</code> the <code>std::future</code>, we can process the returned <code>result<task_result></code> in a call to <a href="#try_handle_some"><code>try_handle_some</code></a>, using the <code>error_handlers</code> tuple we created earlier:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">//std::future<leaf::result<task_result>> fut;
fut.wait();
return leaf::try_handle_some(
[&]() -> leaf::result<void>
{
BOOST_LEAF_AUTO(r, fut.get());
//Success!
return { }
},
error_handlers );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#try_handle_some"><code>try_handle_some</code></a> | <a href="#result"><code>result</code></a> | <a href="#BOOST_LEAF_AUTO"><code>BOOST_LEAF_AUTO</code></a></p>
</div>
<div class="paragraph">
<p>The reason this works is that in case it communicates a failure, <code>leaf::result<T></code> is able to hold a <code>shared_ptr<polymorphic_context></code> object. That is why earlier instead of calling <code>task()</code> directly, we called <code>leaf::capture</code>: it calls the passed function and, in case that fails, it stores the <code>shared_ptr<polymorphic_context></code> we created in the returned <code>result<T></code>, which now doesn’t just communicate the fact that an error has occurred, but also holds the <code>context</code> object that <code>try_handle_some</code> needs in order to supply a suitable handler with arguments.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Follow this link to see a complete example program: <a href="https://github.com/boostorg/leaf/blob/master/examples/capture_in_result.cpp?ts=4">capture_in_result.cpp</a>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="tutorial-async_eh">Using Exception Handling</h4>
<div class="paragraph">
<p>Let’s assume we have an asynchronous <code>task</code> which produces a <code>task_result</code> but could also throw:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">task_result task();</code></pre>
</div>
</div>
<div class="paragraph">
<p>Just like we saw in <a href="#tutorial-async_result">Using <code>result<T></code></a>, first we will bind our error handlers in a <code>std::tuple</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">auto handle_errors = std::make_tuple(
{
[](E1 e1, E2 e2)
{
//Deal with E1, E2
....
return { };
},
[](E3 e3)
{
//Deal with E3
....
return { };
} );</code></pre>
</div>
</div>
<div class="paragraph">
<p>Launching the task looks the same as before, except that we don’t use <code>result<T></code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">std::future<task_result> launch_task()
{
return std::async(
std::launch::async,
[&]
{
std::shared_ptr<leaf::polymorphic_context> ctx = leaf::make_shared_context(&handle_error);
return leaf::capture(ctx, &task);
} );
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#make_shared_context"><code>make_shared_context</code></a> | <a href="#capture"><code>capture</code></a></p>
</div>
<div class="paragraph">
<p>That’s it! Later when we <code>get</code> the <code>std::future</code>, we can process the returned <code>task_result</code> in a call to <a href="#try_catch"><code>try_catch</code></a>, using the <code>error_handlers</code> we saved earlier, as if it was generated locally:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">//std::future<task_result> fut;
fut.wait();
return leaf::try_catch(
[&]
{
task_result r = fut.get(); // Throws on error
//Success!
},
error_handlers );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#try_catch"><code>try_catch</code></a></p>
</div>
<div class="paragraph">
<p>This works similarly to using <code>result<T></code>, except that the <code>std::shared_ptr<polymorphic_context></code> is transported in an exception object (of unspecified type which <a href="#try_catch"><code>try_catch</code></a> recognizes and then automatically unwraps the original exception).</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Follow this link to see a complete example program: <a href="https://github.com/boostorg/leaf/blob/master/examples/capture_in_exception.cpp?ts=4">capture_in_exception.cpp</a>.
</td>
</tr>
</table>
</div>
<hr>
</div>
</div>
<div class="sect2">
<h3 id="tutorial-classification">Classification of Failures</h3>
<div class="paragraph">
<p>It is common for any given interface to define an <code>enum</code> that lists all possible error codes that the API reports. The benefit of this approach is that the list is complete and usually contains comments, so we know where to go for reference.</p>
</div>
<div class="paragraph">
<p>The disadvantage of such flat enums is that they do not support handling a whole class of failures. Consider this error handler from the <a href="#introduction-result">introduction section</a>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">....
[](leaf::match<error_code, size_error, read_error, eof_error>, leaf::e_errno const * errn, leaf::e_file_name const & fn)
{
std::cerr << "Failed to access " << fn.value;
if( errn )
std::cerr << ", errno=" << *errn;
std::cerr << std::endl;
return 3;
},
....</code></pre>
</div>
</div>
<div class="paragraph">
<p>It will get called if the value of the <code>error_code</code> enum communicated with the failure is one of <code>size_error</code>, <code>read_error</code> or <code>eof_error</code>. In short, the idea is to handle any input error.</p>
</div>
<div class="paragraph">
<p>But what if later we add support for detecting and reporting a new type of input error, e.g. <code>permissions_error</code>? It is easy to add that to our <code>error_code</code> enum; but now our input error handler won’t recognize this new input error — and we have a bug.</p>
</div>
<div class="paragraph">
<p>If we can use exceptions, the situation is better because exception types can be organized in a hierarchy in order to classify failures:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct input_error: std::exception { };
struct read_error: input_error { };
struct size_error: input_error { };
struct eof_error: input_error { };</code></pre>
</div>
</div>
<div class="paragraph">
<p>In terms of LEAF, our input error exception handler now looks like this:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">[](input_error &, leaf::e_errno const * errn, leaf::e_file_name const & fn)
{
std::cerr << "Failed to access " << fn.value;
if( errn )
std::cerr << ", errno=" << *errn;
std::cerr << std::endl;
return 3;
},</code></pre>
</div>
</div>
<div class="paragraph">
<p>This is future-proof, but still not ideal, because it is not possible to refine the classification of the failure after the exception object has been thrown.</p>
</div>
<div class="paragraph">
<p>LEAF supports a novel style of error handling where the classification of failures does not use error code values or exception type hierarchies. If we go back to the introduction section, instead of defining:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum error_code
{
....
read_error,
size_error,
eof_error,
....
};</code></pre>
</div>
</div>
<div class="paragraph">
<p>We could define:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">....
struct input_error { };
struct read_error { };
struct size_error { };
struct eof_error { };
....</code></pre>
</div>
</div>
<div class="paragraph">
<p>With this in place, <code>file_read</code> from the <a href="https://github.com/boostorg/leaf/blob/master/examples/print_file/print_file_result.cpp?ts=4">print_file_result.cpp</a> example can be rewritten like this:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<void> file_read( FILE & f, void * buf, int size )
{
int n = fread(buf, 1, size, &f);
if( ferror(&f) )
return leaf::new_error(input_error{}, read_error{}, leaf::e_errno{errno}); <i class="conum" data-value="1"></i><b>(1)</b>
if( n!=size )
return leaf::new_error(input_error{}, eof_error{}); <i class="conum" data-value="2"></i><b>(2)</b>
return { };
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#new_error"><code>new_error</code></a> | <a href="#e_errno"><code>e_errno</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>This error is classified as <code>input_error</code> and <code>read_error</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>This error is classified as <code>input_error</code> and <code>eof_error</code>.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Or, even better:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<void> file_read( FILE & f, void * buf, int size )
{
auto load = leaf::on_error(input_error{}); <i class="conum" data-value="1"></i><b>(1)</b>
int n = fread(buf, 1, size, &f);
if( ferror(&f) )
return leaf::new_error(read_error{}, leaf::e_errno{errno}); <i class="conum" data-value="2"></i><b>(2)</b>
if( n!=size )
return leaf::new_error(eof_error{}); <i class="conum" data-value="3"></i><b>(3)</b>
return { };
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#on_error"><code>on_error</code></a> | <a href="#new_error"><code>new_error</code></a> | <a href="#e_errno"><code>e_errno</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Any error escaping this scope will be classified as <code>input_error</code></td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>In addition, this error is classified as <code>read_error</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>In addition, this error is classified as <code>eof_error</code>.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>This technique works just as well if we choose to use exception handling:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">void file_read( FILE & f, void * buf, int size )
{
auto load = leaf::on_error(input_error{});
int n = fread(buf, 1, size, &f);
if( ferror(&f) )
throw leaf::exception(read_error{}, leaf::e_errno{errno});
if( n!=size )
throw leaf::exception(eof_error{});
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#on_error"><code>on_error</code></a> | <a href="#exception"><code>exception</code></a> | <a href="#e_errno"><code>e_errno</code></a></p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
If the type of the first argument passed to <code>leaf::exception</code> derives from <code>std::exception</code>, it will be used to initialize the returned exception object taken by <code>throw</code>. Here this is not the case, so the function returns a default-initialized <code>std::exception</code> object, while the first (and any other) argument is associated with the failure.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>And now we can write a future-proof handler that can handle any <code>input_error</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">....
[](input_error, leaf::e_errno const * errn, leaf::e_file_name const & fn)
{
std::cerr << "Failed to access " << fn.value;
if( errn )
std::cerr << ", errno=" << *errn;
std::cerr << std::endl;
return 3;
},
....</code></pre>
</div>
</div>
<div class="paragraph">
<p>Remarkably, because the classification of the failure does not depend on error codes or on exception types, this error handler can be used with <code>try_catch</code> if we use exception handling, or with <code>try_handle_some</code>/<code>try_handle_all</code> if we do not. Here is the complete example from the introduction section, rewritten to use this technique:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="https://github.com/boostorg/leaf/blob/master/examples/print_file/print_file_result_error_tags.cpp?ts=4">print_file_result_error_tags.cpp</a> (using <code>leaf::result<T></code>).</p>
</li>
<li>
<p><a href="https://github.com/boostorg/leaf/blob/master/examples/print_file/print_file_eh_error_tags.cpp?ts=4">print_file_eh_error_tags.cpp</a> (using exception handling).</p>
</li>
</ul>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="tutorial-exception_to_result">Converting Exceptions to <code>result<T></code></h3>
<div class="paragraph">
<p>It is sometimes necessary to catch exceptions thrown by a lower-level library function, and report the error through different means, to a higher-level library which may not use exception handling.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Understand that error handlers that take arguments of types that derive from <code>std::exception</code> work correctly — regardless of whether the error object itself is thrown as an exception, or <a href="#tutorial-loading">loaded</a> into a <a href="#context"><code>context</code></a>. The technique described here is only needed when the exception must be communicated through functions which are not exception-safe, or are compiled with exception-handling disabled.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Suppose we have an exception type hierarchy and a function <code>compute_answer_throws</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">class error_base: public std::exception { };
class error_a: public error_base { };
class error_b: public error_base { };
class error_c: public error_base { };
int compute_answer_throws()
{
switch( rand()%4 )
{
default: return 42;
case 1: throw error_a();
case 2: throw error_b();
case 3: throw error_c();
}
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>We can write a simple wrapper using <code>exception_to_result</code>, which calls <code>compute_answer_throws</code> and switches to <code>result<int></code> for error handling:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<int> compute_answer() noexcept
{
return leaf::exception_to_result<error_a, error_b>(
[]
{
return compute_answer_throws();
} );
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#exception_to_result"><code>exception_to_result</code></a></p>
</div>
<div class="paragraph">
<p>The <code>exception_to_result</code> template takes any number of exception types. All exception types thrown by the passed function are caught, and an attempt is made to convert the exception object to each of the specified types. Each successfully-converted slice of the caught exception object, as well as the return value of <code>std::current_exception</code>, are copied and <a href="#tutorial-loading">loaded</a>, and in the end the exception is converted to a <code><a href="#result">result</a><T></code> object.</p>
</div>
<div class="paragraph">
<p>(In our example, <code>error_a</code> and <code>error_b</code> slices as communicated as error objects, but <code>error_c</code> exceptions will still be captured by <code>std::exception_ptr</code>).</p>
</div>
<div class="paragraph">
<p>Here is a simple function which prints successfully computed answers, forwarding any error (originally reported by throwing an exception) to its caller:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<void> print_answer() noexcept
{
BOOST_LEAF_AUTO(answer, compute_answer());
std::cout << "Answer: " << answer << std::endl;
return { };
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#BOOST_LEAF_AUTO"><code>BOOST_LEAF_AUTO</code></a></p>
</div>
<div class="paragraph">
<p>Finally, here is a scope that handles the errors — it will work correctly regardless of whether <code>error_a</code> and <code>error_b</code> objects are thrown as exceptions or not.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::try_handle_all(
[]() -> leaf::result<void>
{
BOOST_LEAF_CHECK(print_answer());
return { };
},
[](error_a const & e)
{
std::cerr << "Error A!" << std::endl;
},
[](error_b const & e)
{
std::cerr << "Error B!" << std::endl;
},
[]
{
std::cerr << "Unknown error!" << std::endl;
} );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#try_handle_all"><code>try_handle_all</code></a> | <a href="#result"><code>result</code></a> | <a href="#BOOST_LEAF_CHECK"><code>BOOST_LEAF_CHECK</code></a></p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
The complete program illustrating this technique is available <a href="https://github.com/boostorg/leaf/blob/master/examples/exception_to_result.cpp?ts=4">here</a>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="tutorial-on_error_in_c_callbacks">Using <code>error_monitor</code> to Report Arbitrary Errors from C-callbacks</h3>
<div class="paragraph">
<p>Communicating information pertaining to a failure detected in a C callback is tricky, because C callbacks are limited to a specific static signature, which may not use C++ types.</p>
</div>
<div class="paragraph">
<p>LEAF makes this easy. As an example, we’ll write a program that uses Lua and reports a failure from a C++ function registered as a C callback, called from a Lua program. The failure will be propagated from C++, through the Lua interpreter (written in C), back to the C++ function which called it.</p>
</div>
<div class="paragraph">
<p>C/C++ functions designed to be invoked from a Lua program must use the following signature:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c" data-lang="c">int do_work( lua_State * L ) ;</code></pre>
</div>
</div>
<div class="paragraph">
<p>Arguments are passed on the Lua stack (which is accessible through <code>L</code>). Results too are pushed onto the Lua stack.</p>
</div>
<div class="paragraph">
<p>First, let’s initialize the Lua interpreter and register <code>do_work</code> as a C callback, available for Lua programs to call:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">std::shared_ptr<lua_State> init_lua_state() noexcept
{
std::shared_ptr<lua_State> L(lua_open(), &lua_close); <i class="conum" data-value="1"></i><b>(1)</b>
lua_register(&*L, "do_work", &do_work); <i class="conum" data-value="2"></i><b>(2)</b>
luaL_dostring(&*L, "\ <i class="conum" data-value="3"></i><b>(3)</b>
\n function call_do_work()\
\n return do_work()\
\n end");
return L;
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Create a new <code>lua_State</code>. We’ll use <code>std::shared_ptr</code> for automatic cleanup.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Register the <code>do_work</code> C++ function as a C callback, under the global name <code>do_work</code>. With this, calls from Lua programs to <code>do_work</code> will land in the <code>do_work</code> C++ function.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Pass some Lua code as a <code>C</code> string literal to Lua. This creates a global Lua function called <code>call_do_work</code>, which we will later ask Lua to execute.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Next, let’s define our <code>enum</code> used to communicate <code>do_work</code> failures:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum do_work_error_code
{
ec1=1,
ec2
};</code></pre>
</div>
</div>
<div class="paragraph">
<p>We’re now ready to define the <code>do_work</code> callback function:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">int do_work( lua_State * L ) noexcept
{
bool success = rand()%2; <i class="conum" data-value="1"></i><b>(1)</b>
if( success )
{
lua_pushnumber(L, 42); <i class="conum" data-value="2"></i><b>(2)</b>
return 1;
}
else
{
leaf::new_error(ec1); <i class="conum" data-value="3"></i><b>(3)</b>
return luaL_error(L, "do_work_error"); <i class="conum" data-value="4"></i><b>(4)</b>
}
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#new_error"><code>new_error</code></a> | <a href="#error_id::load"><code>load</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>"Sometimes" <code>do_work</code> fails.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>In case of success, push the result on the Lua stack, return back to Lua.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Generate a new <code>error_id</code> and associate a <code>do_work_error_code</code> with it. Normally, we’d return this in a <code>leaf::result<T></code>, but the <code>do_work</code> function signature (required by Lua) does not permit this.</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>Tell the Lua interpreter to abort the Lua program.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Now we’ll write the function that calls the Lua interpreter to execute the Lua function <code>call_do_work</code>, which in turn calls <code>do_work</code>. We’ll return <code><a href="#result">result</a><int></code>, so that our caller can get the answer in case of success, or an error:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<int> call_lua( lua_State * L )
{
lua_getfield(L, LUA_GLOBALSINDEX, "call_do_work");
error_monitor cur_err;
if( int err=lua_pcall(L, 0, 1, 0) ) <i class="conum" data-value="1"></i><b>(1)</b>
{
auto load = leaf::on_error(e_lua_error_message{lua_tostring(L,1)}); <i class="conum" data-value="2"></i><b>(2)</b>
lua_pop(L,1);
return cur_err.assigned_error_id().load(e_lua_pcall_error{err}); <i class="conum" data-value="3"></i><b>(3)</b>
}
else
{
int answer = lua_tonumber(L, -1); <i class="conum" data-value="4"></i><b>(4)</b>
lua_pop(L, 1);
return answer;
}
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#on_error"><code>on_error</code></a> | <a href="#error_monitor"><code>error_monitor</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Ask the Lua interpreter to call the global Lua function <code>call_do_work</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td><code>on_error</code> works as usual.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td><code>load</code> will use the <code>error_id</code> generated in our Lua callback. This is the same <code>error_id</code> the <code>on_error</code> uses as well.</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>Success! Just return the <code>int</code> answer.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Finally, here is the <code>main</code> function which exercises <code>call_lua</code>, each time handling any failure:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">int main() noexcept
{
std::shared_ptr<lua_State> L=init_lua_state();
for( int i=0; i!=10; ++i )
{
leaf::try_handle_all(
[&]() -> leaf::result<void>
{
BOOST_LEAF_AUTO(answer, call_lua(&*L));
std::cout << "do_work succeeded, answer=" << answer << '\n'; <i class="conum" data-value="1"></i><b>(1)</b>
return { };
},
[](do_work_error_code e) <i class="conum" data-value="2"></i><b>(2)</b>
{
std::cout << "Got do_work_error_code = " << e << "!\n";
},
[](e_lua_pcall_error const & err, e_lua_error_message const & msg) <i class="conum" data-value="3"></i><b>(3)</b>
{
std::cout << "Got e_lua_pcall_error, Lua error code = " << err.value << ", " << msg.value << "\n";
},
[](leaf::error_info const & unmatched)
{
std::cerr <<
"Unknown failure detected" << std::endl <<
"Cryptic diagnostic information follows" << std::endl <<
unmatched;
} );
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#try_handle_all"><code>try_handle_all</code></a> | <a href="#result"><code>result</code></a> | <a href="#BOOST_LEAF_AUTO"><code>BOOST_LEAF_AUTO</code></a> | <a href="#error_info"><code>error_info</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>If the call to <code>call_lua</code> succeeded, just print the answer.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Handle <code>do_work</code> failures.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Handle all other <code>lua_pcall</code> failures.</td>
</tr>
</table>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>Follow this link to see the complete program: <a href="https://github.com/boostorg/leaf/blob/master/examples/lua_callback_result.cpp?ts=4">lua_callback_result.cpp</a>.</p>
</div>
<div class="paragraph">
<p>Remarkably, the Lua interpreter is C++ exception-safe, even though it is written in C. Here is the same program, this time using a C++ exception to report failures from <code>do_work</code>: <a href="https://github.com/boostorg/leaf/blob/master/examples/lua_callback_eh.cpp?ts=4">lua_callback_eh.cpp</a>.</p>
</div>
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="tutorial-diagnostic_information">Diagnostic Information</h3>
<div class="paragraph">
<p>LEAF is able to automatically generate diagnostic messages that include information about all error objects available to error handlers. For this purpose, it needs to be able to print objects of user-defined error types.</p>
</div>
<div class="paragraph">
<p>To do this, LEAF attempts to bind an unqualified call to <code>operator<<</code>, passing a <code>std::ostream</code> and the error object. If that fails, it will also attempt to bind <code>operator<<</code> that takes the <code>.value</code> of the error type. If that also doesn’t compile, the error object value will not appear in diagnostic messages, though LEAF will still print its type.</p>
</div>
<div class="paragraph">
<p>Even with error types that define a printable <code>.value</code>, the user may still want to overload <code>operator<<</code> for the enclosing <code>struct</code>, e.g.:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct e_errno
{
int value;
friend std::ostream & operator<<( std::ostream & os, e_errno const & e )
{
return os << "errno = " << e.value << ", \"" << strerror(e.value) << '"';
}
};</code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>e_errno</code> type above is designed to hold <code>errno</code> values. The defined <code>operator<<</code> overload will automatically include the output from <code>strerror</code> when <code>e_errno</code> values are printed (LEAF defines <code>e_errno</code> in <code><boost/leaf/common.hpp></code>, together with other commonly-used error types).</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
The automatically-generated diagnostic messages are developer-friendly, but not user-friendly. Therefore, <code>operator<<</code> overloads for error types should only print technical information in English, and should not attempt to localize strings or to format a user-friendly message; this should be done in error-handling functions specifically designed for that purpose.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="tutorial-std_error_code">Working with <code>std::error_code</code>, <code>std::error_condition</code></h3>
<div class="sect3">
<h4 id="_introduction">Introduction</h4>
<div class="paragraph">
<p>The relationship between <code>std::error_code</code> and <code>std::error_condition</code> is not easily understood from reading the standard specifications. This section explains how they’re supposed to be used, and how LEAF interacts with them.</p>
</div>
<div class="paragraph">
<p>The idea behind <code>std::error_code</code> is to encode both an integer value representing an error code, as well as the domain of that value. The domain is represented by a <code>std::error_category</code> <span class="underline">reference</span>. Conceptually, a <code>std::error_code</code> is like a <code>pair<std::error_category const &, int></code>.</p>
</div>
<div class="paragraph">
<p>Let’s say we have this <code>enum</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum class libfoo_error
{
e1 = 1,
e2,
e3
};</code></pre>
</div>
</div>
<div class="paragraph">
<p>We want to be able to transport <code>libfoo_error</code> values in <code>std::error_code</code> objects. This erases their static type, which enables them to travel freely across API boundaries. To this end, we must define a <code>std::error_category</code> that represents our <code>libfoo_error</code> type:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">std::error_category const & libfoo_error_category()
{
struct category: std::error_category
{
char const * name() const noexcept override
{
return "libfoo";
}
std::string message(int code) const override
{
switch( libfoo_error(code) )
{
case libfoo_error::e1: return "e1";
case libfoo_error::e2: return "e2";
case libfoo_error::e3: return "e3";
default: return "error";
}
}
};
static category c;
return c;
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>We also need to inform the standard library that <code>libfoo_error</code> is compatible with <code>std::error_code</code>, and provide a factory function which can be used to make <code>std::error_code</code> objects out of <code>libfoo_error</code> values:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace std
{
template <>
struct is_error_code_enum<libfoo_error>: std::true_type
{
};
}
std::error_code make_error_code(libfoo_error e)
{
return std::error_code(int(e), libfoo_error_category());
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>With this in place, if we receive a <code>std::error_code</code>, we can easily check if it represents some of the <code>libfoo_error</code> values we’re interested in:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">std::error_code f();
....
auto ec = f();
if( ec == libfoo_error::e1 || ec == libfoo_error::e2 )
{
// We got either a libfoo_error::e1 or a libfoo_error::e2
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>This works because the standard library detects that <code>std::is_error_code_enum<libfoo_error>::value</code> is <code>true</code>, and then uses <code>make_error_code</code> to create a <code>std::error_code</code> object it actually uses to compare to <code>ec</code>.</p>
</div>
<div class="paragraph">
<p>So far so good, but remember, the standard library defines another type also, <code>std::error_condition</code>. The first confusing thing is that in terms of its physical representation, <code>std::error_condition</code> is identical to <code>std::error_code</code>; that is, it is also like a pair of <code>std::error_category</code> reference and an <code>int</code>. Why do we need two different types which use identical physical representation?</p>
</div>
<div class="paragraph">
<p>The key to answering this question is to understand that <code>std::error_code</code> objects are designed to be returned from functions to indicate failures. In contrast, <code>std::error_condition</code> objects are <span class="underline">never</span> supposed to be communicated; their purpose is to interpret the <code>std::error_code</code> values being communicated. The idea is that in a given program there may be multiple different "physical" (maybe platform-specific) <code>std::error_code</code> values which all indicate the same "logical" <code>std::error_condition</code>.</p>
</div>
<div class="paragraph">
<p>This leads us to the second confusing thing about <code>std::error_condition</code>: it uses the same <code>std::error_category</code> type, but for a completely different purpose: to specify what <code>std::error_code</code> values are equivalent to what <code>std::error_condition</code> values.</p>
</div>
<div class="paragraph">
<p>Let’s say that in addition to <code>libfoo</code>, our program uses another library, <code>libbar</code>, which communicates failures in terms of <code>std::error_code</code> with a different error category. Perhaps <code>libbar_error</code> looks like this:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum class libbar_error
{
e1 = 1,
e2,
e3,
e4
};
// Boilerplate omitted:
// - libbar_error_category()
// - specialization of std::is_error_code_enum
// - make_error_code factory function for libbar_error.</code></pre>
</div>
</div>
<div class="paragraph">
<p>We can now use <code>std::error_condition</code> to define the <em>logical</em> error conditions represented by the <code>std::error_code</code> values communicated by <code>libfoo</code> and <code>libbar</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum class my_error_condition <i class="conum" data-value="1"></i><b>(1)</b>
{
c1 = 1,
c2
};
std::error_category const & libfoo_error_category() <i class="conum" data-value="2"></i><b>(2)</b>
{
struct category: std::error_category
{
char const * name() const noexcept override
{
return "my_error_condition";
}
std::string message(int cond) const override
{
switch( my_error_condition(code) )
{
case my_error_condition::c1: return "c1";
case my_error_condition::c2: return "c2";
default: return "error";
}
}
bool equivalent(std::error_code const & code, int cond) const noexcept
{
switch( my_error_condition(cond) )
{
case my_error_condition::c1: <i class="conum" data-value="3"></i><b>(3)</b>
return
code == libfoo_error::e1 ||
code == libbar_error::e3 ||
code == libbar_error::e4;
case my_error_condition::c2: <i class="conum" data-value="4"></i><b>(4)</b>
return
code == libfoo_error::e2 ||
code == libbar_error::e1 ||
code == libbar_error::e2;
default:
return false;
}
}
};
static category c;
return c;
}
namespace std
{
template <> <i class="conum" data-value="5"></i><b>(5)</b>
class is_error_condition_enum<my_error_condition>: std::true_type
{
};
}
std::error_condition make_error_condition(my_error_condition e) <i class="conum" data-value="6"></i><b>(6)</b>
{
return std::error_condition(int(e), my_error_condition_error_category());
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Enumeration of the two logical error conditions, <code>c1</code> and <code>c2</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Define the <code>std::error_category</code> for <code>std::error_condition</code> objects that represent a <code>my_error_condition</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Here we specify that any of <code>libfoo:error::e1</code>, <code>libbar_error::e3</code> and <code>libbar_error::e4</code> are logically equivalent to <code>my_error_condition::c1</code>, and that…​</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>…​any of <code>libfoo:error::e2</code>, <code>libbar_error::e1</code> and <code>libbar_error::e2</code> are logically equivalent to <code>my_error_condition::c2</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="5"></i><b>5</b></td>
<td>This specialization tells the standard library that the <code>my_error_condition</code> enum is designed to be used with <code>std::error_condition</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="6"></i><b>6</b></td>
<td>The factory function to make <code>std::error_condition</code> objects out of <code>my_error_condition</code> values.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Phew!</p>
</div>
<div class="paragraph">
<p>Now, if we have a <code>std::error_code</code> object <code>ec</code>, we can easily check if it is equivalent to <code>my_error_condition::c1</code> like so:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">if( ec == my_error_condition::c1 )
{
// We have a c1 in our hands
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>Again, remember that beyond defining the <code>std::error_category</code> for <code>std::error_condition</code> objects initialized with a <code>my_error_condition</code> value, we don’t need to interact with the actual <code>std::error_condition</code> instances: they’re created when needed to compare to a <code>std::error_code</code>, and that’s pretty much all they’re good for.</p>
</div>
</div>
<div class="sect3">
<h4 id="_support_in_leaf">Support in LEAF</h4>
<div class="paragraph">
<p>The following support for <code>std::error_code</code> and <code>std::error_condition</code> is available:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>The <a href="#match"><code>match</code></a> template can be used as an argument to a LEAF error handler, so it can be considered based on the value of a communicated <code>std::error_code</code>.</p>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
See <a href="#match"><code>match</code></a> for examples.
</td>
</tr>
</table>
</div>
</li>
<li>
<p>The <a href="#error_id"><code>error_id</code></a> type can be converted to a <code>std::error_code</code>; see <a href="#error_id::to_error_code"><code>to_error_code</code></a>. The returned object encodes the state of the <code>error_id</code> without any loss of information. This is useful if an <code>error_id</code> needs to be communicated through interfaces that support <code>std::error_code</code> but do not use LEAF.</p>
</li>
<li>
<p>The <code>error_id</code> type can be implicitly initialized with a <code>std::error_code</code>. If the <code>std::error_code</code> was created using <code>to_error_code</code>, the original <code>error_id</code> state is restored. Otherwise, the <code>std::error_code</code> is <a href="#tutorial-loading">loaded</a> so it can be used by LEAF error handlers, while the <code>error_id</code> itself is initialized by <a href="#new_error"><code>new_error</code></a>.</p>
</li>
<li>
<p>The <code>leaf::result<T></code> type can be implicitly initialized with an <code>error_id</code>, which means that it can be implicitly initialized with a <code>std::error_code</code>.</p>
</li>
</ul>
</div>
<hr>
</div>
</div>
<div class="sect2">
<h3 id="tutorial-boost_exception_integration">Boost Exception Integration</h3>
<div class="paragraph">
<p>Instead of the <a href="https://www.boost.org/doc/libs/release/libs/exception/doc/get_error_info.html"><code>boost::get_error_info</code></a> API defined by Boost Exception, it is possible to use LEAF error handlers directly. Consider the following use of <code>boost::get_error_info</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">typedef boost::error_info<struct my_info_, int> my_info;
void f(); // Throws using boost::throw_exception
void g()
{
try
{
f();
},
catch( boost::exception & e )
{
if( int const * x = boost::get_error_info<my_info>(e) )
std::cerr << "Got my_info with value = " << *x;
} );
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>We can rewrite <code>g</code> to access <code>my_info</code> using LEAF:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">#include <boost/leaf/handle_errors.hpp>
void g()
{
leaf::try_catch(
[]
{
f();
},
[]( my_info x )
{
std::cerr << "Got my_info with value = " << x.value();
} );
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#try_catch"><code>try_catch</code></a></p>
</div>
<div class="paragraph">
<p>Taking <code>my_info</code> means that the handler will only be selected if the caught exception object carries <code>my_info</code> (which LEAF accesses via <code>boost::get_error_info</code>).</p>
</div>
<div class="paragraph">
<p>The use of <a href="#match"><code>match</code></a> is also supported:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">void g()
{
leaf::try_catch(
[]
{
f();
},
[]( leaf::match_value<my_info, 42> )
{
std::cerr << "Got my_info with value = 42";
} );
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>Above, the handler will be selected if the caught exception object carries <code>my_info</code> with <code>.value()</code> equal to 42.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="examples">Examples</h2>
<div class="sectionbody">
<div class="paragraph">
<p>See <a href="https://github.com/boostorg/leaf/tree/master/examples">github</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="synopsis">Synopsis</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This section lists each public header file in LEAF, documenting the definitions it provides.</p>
</div>
<div class="paragraph">
<p>LEAF headers are designed to minimize coupling:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Headers needed to report or forward but not handle errors are lighter than headers providing error-handling functionality.</p>
</li>
<li>
<p>Headers that provide exception handling or throwing functionality are separate from headers that provide error-handling or reporting but do not use exceptions.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>A standalone single-header option is available; please <code>#include <boost/leaf.hpp></code>.</p>
</div>
<hr>
<div class="sect2">
<h3 id="synopsis-reporting">Error Reporting</h3>
<div class="sect3">
<h4 id="error.hpp"><code>error.hpp</code></h4>
<div class="exampleblock">
<div class="content">
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
class error_id
{
public:
error_id() noexcept;
template <class Enum>
error_id( Enum e, typename std::enable_if<std::is_error_code_enum<Enum>::value, Enum>::type * = 0 ) noexcept;
error_id( std::error_code const & ec ) noexcept;
int value() const noexcept;
explicit operator bool() const noexcept;
std::error_code to_error_code() const noexept;
friend bool operator==( error_id a, error_id b ) noexcept;
friend bool operator!=( error_id a, error_id b ) noexcept;
friend bool operator<( error_id a, error_id b ) noexcept;
template <class... Item>
error_id load( Item && ... item ) const noexcept;
friend std::ostream & operator<<( std::ostream & os, error_id x );
};
bool is_error_id( std::error_code const & ec ) noexcept;
template <class... Item>
error_id new_error( Item && ... item ) noexcept;
error_id current_error() noexcept;
//////////////////////////////////////////
class polymorphic_context
{
protected:
polymorphic_context() noexcept = default;
~polymorphic_context() noexcept = default;
public:
virtual void activate() noexcept = 0;
virtual void deactivate() noexcept = 0;
virtual bool is_active() const noexcept = 0;
virtual void propagate() noexcept = 0;
virtual void print( std::ostream & ) const = 0;
};
//////////////////////////////////////////
template <class Ctx>
class context_activator
{
context_activator( context_activator const & ) = delete;
context_activator & operator=( context_activator const & ) = delete;
public:
explicit context_activator( Ctx & ctx ) noexcept;
context_activator( context_activator && ) noexcept;
~context_activator() noexcept;
};
template <class Ctx>
context_activator<Ctx> activate_context( Ctx & ctx ) noexcept;
template <class R>
struct is_result_type: std::false_type
{
};
template <class R>
struct is_result_type<R const>: is_result_type<R>
{
};
} }
#define BOOST_LEAF_ASSIGN(v, r)\
auto && <<temp>> = r;\
if( !<<temp>> )\
return <<temp>>.error();\
v = std::forward<decltype(<<temp>>)>(<<temp>>).value()
#define BOOST_LEAF_AUTO(v, r)\
BOOST_LEAF_ASSIGN(auto v, r)
#define BOOST_LEAF_CHECK(r)\
{\
auto && <<temp>> = r;\
if( !<<temp>> )\
return <<temp>>.error();\
}
#define BOOST_LEAF_NEW_ERROR <<inject e_source_location voodoo>> ::boost::leaf::new_error</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p>Reference: <a href="#error_id"><code>error_id</code></a> | <a href="#is_error_id"><code>is_error_id</code></a> | <a href="#new_error"><code>new_error</code></a> | <a href="#current_error"><code>current_error</code></a> | <a href="#polymorphic_context"><code>polymorphic_context</code></a> | <a href="#context_activator"><code>context_activator</code></a> | <a href="#activate_context"><code>activate_context</code></a> | <a href="#is_result_type"><code>is_result_type</code></a> | <a href="#BOOST_LEAF_ASSIGN"><code>BOOST_LEAF_ASSIGN</code></a> | <a href="#BOOST_LEAF_AUTO"><code>BOOST_LEAF_AUTO</code></a> | <a href="#BOOST_LEAF_CHECK"><code>BOOST_LEAF_CHECK</code></a> | <a href="#BOOST_LEAF_NEW_ERROR"><code>BOOST_LEAF_NEW_ERROR</code></a></p>
</div>
</div>
</div>
</div>
<div class="sect3">
<h4 id="common.hpp"><code>common.hpp</code></h4>
<div class="exampleblock">
<div class="content">
<div class="listingblock">
<div class="title">#include <boost/leaf/common.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
struct e_api_function { char const * value; };
struct e_file_name { std::string value; };
struct e_type_info_name { char const * value; };
struct e_at_line { int value; };
struct e_errno
{
int value;
friend std::ostream & operator<<( std::ostream &, e_errno const & );
};
namespace windows
{
struct e_LastError
{
unsigned value;
friend std::ostream & operator<<( std::ostream &, e_LastError const & );
};
}
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p>Reference: <a href="#e_api_function"><code>e_api_function</code></a> | <a href="#e_file_name"><code>e_file_name</code></a> | <a href="#e_at_line"><code>e_at_line</code></a> | <a href="#e_type_info_name"><code>e_type_info_name</code></a> | <a href="#e_source_location"><code>e_source_location</code></a> | <a href="#e_errno"><code>e_errno</code></a> | <a href="#e_LastError"><code>e_LastError</code></a></p>
</div>
</div>
</div>
</div>
<div class="sect3">
<h4 id="result.hpp"><code>result.hpp</code></h4>
<div class="exampleblock">
<div class="content">
<div class="listingblock">
<div class="title">#include <boost/leaf/result.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class T>
class result
{
public:
result() noexcept;
result( T && v ) noexcept;
result( T const & v );
template <class U>
result( U && u, <<enabled_if_T_can_be_inited_with_U>> );
result( error_id err ) noexcept;
result( std::shared_ptr<polymorphic_context> && ctx ) noexcept;
template <class Enum>
result( Enum e, typename std::enable_if<std::is_error_code_enum<Enum>::value, Enum>::type * = 0 ) noexcept;
result( std::error_code const & ec ) noexcept;
result( result && r ) noexcept;
template <class U>
result( result<U> && r ) noexcept;
result & operator=( result && r ) noexcept;
template <class U>
result & operator=( result<U> && r ) noexcept;
explicit operator bool() const noexcept;
T const & value() const;
T & value();
T const & operator*() const;
T & operator*();
T const * operator->() const;
T * operator->();
<<unspecified-type>> error() noexcept;
template <class... Item>
error_id load( Item && ... item ) noexcept;
};
template <>
class result<void>
{
public:
result() noexcept;
result( error_id err ) noexcept;
result( std::shared_ptr<polymorphic_context> && ctx ) noexcept;
template <class Enum>
result( Enum e, typename std::enable_if<std::is_error_code_enum<Enum>::value, Enum>::type * = 0 ) noexcept;
result( std::error_code const & ec ) noexcept;
result( result && r ) noexcept;
template <class U>
result( result<U> && r ) noexcept;
result & operator=( result && r ) noexcept;
template <class U>
result & operator=( result<U> && r ) noexcept;
explicit operator bool() const noexcept;
void value() const;
<<unspecified-type>> error() noexcept;
template <class... Item>
error_id load( Item && ... item ) noexcept;
};
struct bad_result: std::exception { };
template <class T>
struct is_result_type<result<T>>: std::true_type
{
};
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p>Reference: <a href="#result"><code>result</code></a> | <a href="#is_result_type"><code>is_result_type</code></a></p>
</div>
</div>
</div>
</div>
<div class="sect3">
<h4 id="on_error.hpp"><code>on_error.hpp</code></h4>
<div class="exampleblock">
<div class="content">
<div class="listingblock">
<div class="title">#include <boost/leaf/on_error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... Item>
<<unspecified-type>> on_error( Item && ... e ) noexcept;
class error_monitor
{
public:
error_monitor() noexcept;
error_id check() const noexcept;
error_id assigned_error_id() const noexcept;
};
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p>Reference: <a href="#on_error"><code>on_error</code></a> | <a href="#error_monitor"><code>error_monitor</code></a></p>
</div>
</div>
</div>
</div>
<div class="sect3">
<h4 id="exception.hpp"><code>exception.hpp</code></h4>
<div class="exampleblock">
<div class="content">
<div class="listingblock">
<div class="title">#include <boost/leaf/exception.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class Ex, class... E> <i class="conum" data-value="1"></i><b>(1)</b>
<<unspecified-exception-type>> exception( Ex &&, E && ... ) noexcept;
template <class E1, class... E> <i class="conum" data-value="2"></i><b>(2)</b>
<<unspecified-exception-type>> exception( E1 &&, E && ... ) noexcept;
<<unspecified-exception-type>> exception() noexcept;
} }
#define BOOST_LEAF_EXCEPTION <<inject e_source_location voodoo>> ::boost::leaf::exception
#define BOOST_LEAF_THROW_EXCEPTION <<inject e_source_location + invoke boost::throw_exception voodoo>> ::boost::leaf::exception</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p>Reference: <a href="#exception"><code>exception</code></a> | <a href="#BOOST_LEAF_EXCEPTION"><code>BOOST_LEAF_EXCEPTION</code></a> | <a href="#BOOST_LEAF_THROW_EXCEPTION"><code>BOOST_LEAF_THROW_EXCEPTION</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Only enabled if std::is_base_of<std::exception, Ex>::value.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Only enabled if !std::is_base_of<std::exception, E1>::value.</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_capture_hpp"><code>capture.hpp</code></h4>
<div class="exampleblock">
<div class="content">
<div class="listingblock">
<div class="title">#include <boost/leaf/capture_exception.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class F, class... A>
decltype(std::declval<F>()(std::forward<A>(std::declval<A>())...))
capture(std::shared_ptr<polymorphic_context> && ctx, F && f, A... a);
template <class... Ex, class F>
<<result<T>-deduced>> exception_to_result( F && f ) noexcept;
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p>Reference: <a href="#capture"><code>capture</code></a> | <a href="#exception_to_result"><code>exception_to_result</code></a></p>
</div>
</div>
</div>
<hr>
</div>
</div>
<div class="sect2">
<h3 id="tutorial-handling">Error Handling</h3>
<div class="sect3">
<h4 id="context.hpp"><code>context.hpp</code></h4>
<div class="exampleblock">
<div class="content">
<div class="listingblock">
<div class="title">#include <boost/leaf/context.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... E>
class context
{
context( context const & ) = delete;
context & operator=( context const & ) = delete;
public:
context() noexcept;
context( context && x ) noexcept;
~context() noexcept;
void activate() noexcept;
void deactivate() noexcept;
bool is_active() const noexcept;
void propagate () noexcept;
void print( std::ostream & os ) const;
template <class R, class... H>
R handle_error( R &, H && ... ) const;
};
//////////////////////////////////////////
template <class... H>
using context_type_from_handlers = typename <<unspecified>>::type;
template <class... H>
BOOST_LEAF_CONSTEXPR context_type_from_handlers<H...> make_context() noexcept;
template <class... H>
BOOST_LEAF_CONSTEXPR context_type_from_handlers<H...> make_context( H && ... ) noexcept;
template <class... H>
context_ptr make_shared_context() noexcept;
template <class... H>
context_ptr make_shared_context( H && ... ) noexcept;
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p>Reference: <a href="#context"><code>context</code></a> | <a href="#context_type_from_handlers"><code>context_type_from_handlers</code></a> | <a href="#make_context"><code>make_context</code></a> | <a href="#make_shared_context"><code>make_shared_context</code></a></p>
</div>
</div>
</div>
</div>
<div class="sect3">
<h4 id="handle_errors.hpp"><code>handle_errors.hpp</code></h4>
<div class="exampleblock">
<div class="content">
<div class="listingblock">
<div class="title">#include <boost/leaf/handle_errors.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class TryBlock, class... H>
typename std::decay<decltype(std::declval<TryBlock>()().value())>::type
try_handle_all( TryBlock && try_block, H && ... h );
template <class TryBlock, class... H>
typename std::decay<decltype(std::declval<TryBlock>()())>::type
try_handle_some( TryBlock && try_block, H && ... h );
template <class TryBlock, class... H>
typename std::decay<decltype(std::declval<TryBlock>()())>::type
try_catch( TryBlock && try_block, H && ... h );
//////////////////////////////////////////
class error_info
{
//No public constructors
public:
error_id error() const noexcept;
bool exception_caught() const noexcept;
std::exception const * exception() const noexcept;
friend std::ostream & operator<<( std::ostream & os, error_info const & x );
};
class diagnostic_info: public error_info
{
//No public constructors
friend std::ostream & operator<<( std::ostream & os, diagnostic_info const & x );
};
class verbose_diagnostic_info: public error_info
{
//No public constructors
friend std::ostream & operator<<( std::ostream & os, diagnostic_info const & x );
};
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p>Reference: <a href="#try_handle_all"><code>try_handle_all</code></a> | <a href="#try_handle_some"><code>try_handle_some</code></a> | <a href="#try_catch"><code>try_catch</code></a> | <a href="#error_info"><code>error_info</code></a> | <a href="#diagnostic_info"><code>diagnostic_info</code></a> | <a href="#verbose_diagnostic_info"><code>verbose_diagnostic_info</code></a></p>
</div>
</div>
</div>
</div>
<div class="sect3">
<h4 id="pred.hpp"><code>pred.hpp</code></h4>
<div class="exampleblock">
<div class="content">
<div class="listingblock">
<div class="title">#include <boost/leaf/pred.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class T>
struct is_predicate: std::false_type
{
};
template <class E, auto... V>
struct match
{
E matched;
// Other members not specified
};
template <class E, auto... V>
struct is_predicate<match<E, V...>>: std::true_type
{
};
template <class E, auto... V>
struct match_value
{
E matched;
// Other members not specified
};
template <class E, auto... V>
struct is_predicate<match_value<E, V...>>: std::true_type
{
};
template <auto, auto...>
struct match_member;
template <class E, class T, T E::* P, auto... V>
struct member<P, V...>
{
E matched;
// Other members not specified
};
template <auto P, auto... V>
struct is_predicate<match_member<P, V...>>: std::true_type
{
};
template <class... Ex>
struct catch_
{
std::exception const & matched;
// Other members not specified
};
template <class Ex>
struct catch_<Ex>
{
Ex const & matched;
// Other members not specified
};
template <class... Ex>
struct is_predicate<catch_<Ex...>>: std::true_type
{
};
template <class Pred>
struct if_not
{
E matched;
// Other members not specified
};
template <class Pred>
struct is_predicate<if_not<Pred>>: std::true_type
{
};
template <class ErrorCodeEnum>
bool category( std::error_code const & ec ) noexcept;
template <class Enum, class EnumType = Enum>
struct condition;
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p>Reference: <a href="#match"><code>match</code></a> | <a href="#match_value"><code>match_value</code></a> | <a href="#match_member"><code>match_member</code></a> | <a href="#catch_"><code>catch_</code></a> | <a href="#if_not"><code>if_not</code></a> | <a href="#category"><code>category</code></a> | <a href="#condition"><code>condition</code></a></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="functions">Reference: Functions</h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
The contents of each Reference section are organized alphabetically.
</td>
</tr>
</table>
</div>
<hr>
<div class="sect2">
<h3 id="activate_context"><code>activate_context</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class Ctx>
context_activator<Ctx> activate_context( Ctx & ctx ) noexcept
{
return context_activator<Ctx>(ctx);
}
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#context_activator"><code>context_activator</code></a></p>
</div>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::context<E1, E2, E3> ctx;
{
auto active_context = activate_context(ctx); <i class="conum" data-value="1"></i><b>(1)</b>
} <i class="conum" data-value="2"></i><b>(2)</b></code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Activate <code>ctx</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Automatically deactivate <code>ctx</code>.</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="capture"><code>capture</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/capture.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class F, class... A>
decltype(std::declval<F>()(std::forward<A>(std::declval<A>())...))
capture(std::shared_ptr<polymorphic_context> && ctx, F && f, A... a);
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#polymorphic_context"><code>polymorphic_context</code></a></p>
</div>
<div class="paragraph">
<p>This function can be used to capture error objects stored in a <a href="#context"><code>context</code></a> in one thread and transport them to a different thread for handling, either in a <code><a href="#result">result</a><T></code> object or in an exception.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>The same type returned by <code>F</code>.</p>
</dd>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>Uses an internal <a href="#context_activator"><code>context_activator</code></a> to <a href="#context::activate"><code>activate</code></a> <code>*ctx</code>, then invokes <code>std::forward<F>(f)(std::forward<A>(a)…​)</code>. Then:</p>
<div class="openblock">
<div class="content">
<div class="ulist">
<ul>
<li>
<p>If the returned value <code>r</code> is not a <code>result<T></code> type (see <a href="#is_result_type"><code>is_result_type</code></a>), it is forwarded to the caller.</p>
</li>
<li>
<p>Otherwise:</p>
<div class="ulist">
<ul>
<li>
<p>If <code>!r</code>, the return value of <code>capture</code> is initialized with <code>ctx</code>;</p>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
An object of type <code>leaf::<a href="#result">result</a><T></code> can be initialized with a <code>std::shared_ptr<leaf::polymorphic_context></code>.
</td>
</tr>
</table>
</div>
</li>
<li>
<p>otherwise, it is initialized with <code>r</code>.</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
</div>
<div class="paragraph">
<p>In case <code>f</code> throws, <code>capture</code> catches the exception in a <code>std::exception_ptr</code>, and throws a different exception of unspecified type that transports both the <code>std::exception_ptr</code> as well as <code>ctx</code>. This exception type is recognized by <a href="#try_catch"><code>try_catch</code></a>, which automatically unpacks the original exception and propagates the contents of <code>*ctx</code> (presumably, in a different thread).</p>
</div>
</dd>
</dl>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
See also <a href="#tutorial-async">Transporting Error Objects Between Threads</a> from the Tutorial.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="context_type_from_handlers"><code>context_type_from_handlers</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/context.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... H>
using context_type_from_handlers = typename <<unspecified>>::type;
} }</code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">auto error_handlers = std::make_tuple(
[](e_this const & a, e_that const & b)
{
....
},
[](leaf::diagnostic_info const & info)
{
....
},
.... );
leaf::context_type_from_handlers<decltype(error_handlers)> ctx; <i class="conum" data-value="1"></i><b>(1)</b></code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td><code>ctx</code> will be of type <code>context<e_this, e_that></code>, deduced automatically from the specified error handlers.</td>
</tr>
</table>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
Alternatively, a suitable context may be created by calling <a href="#make_context"><code>make_context</code></a>, or allocated dynamically by calling <a href="#make_shared_context"><code>make_shared_context</code></a>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="current_error"><code>current_error</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
error_id current_error() noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>The <code>error_id</code> value returned the last time <a href="#new_error"><code>new_error</code></a> was invoked from the calling thread.</p>
</dd>
</dl>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
See also <a href="#on_error"><code>on_error</code></a>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="exception"><code>exception</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/exception.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class Ex, class... E> <i class="conum" data-value="1"></i><b>(1)</b>
<<unspecified>> exception( Ex && ex, E && ... e ) noexcept;
template <class E1, class... E> <i class="conum" data-value="2"></i><b>(2)</b>
<<unspecified>> exception( E1 && e1, E && ... e ) noexcept;
<<unspecified>> exception() noexcept;
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>exception</code> function is overloaded: it can be invoked with no arguments, or else there are two alternatives, selected using <code>std::enable_if</code> based on the type of the first argument:</p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Selected if the first argument is an exception object, that is, iff <code>Ex</code> derives publicly from <code>std::exception</code>. In this case the return value is of unspecified type which derives publicly from <code>Ex</code> <strong>and</strong> from class <a href="#error_id"><code>error_id</code></a>, such that:
<div class="ulist">
<ul>
<li>
<p>its <code>Ex</code> subobject is initialized by <code>std::forward<Ex>(ex)</code>;</p>
</li>
<li>
<p>its <code>error_id</code> subobject is initialized by <code><a href="#new_error">new_error</a>(std::forward<E>(e)…​</code>).</p>
</li>
</ul>
</div></td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Selected otherwise. In this case the return value is of unspecified type which derives publicly from <code>std::exception</code> <strong>and</strong> from class <code>error_id</code>, such that:
<div class="ulist">
<ul>
<li>
<p>its <code>std::exception</code> subobject is default-initialized;</p>
</li>
<li>
<p>its <code>error_id</code> subobject is initialized by <code><a href="#new_error">new_error</a>(std::forward<E1>(e1), std::forward<E>(e)…​</code>).</p>
</li>
</ul>
</div></td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Example 1:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct my_exception: std::exception { };
throw leaf::exception(my_exception{}); <i class="conum" data-value="1"></i><b>(1)</b></code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Throws an exception of a type that derives from <code>error_id</code> and from <code>my_exception</code> (because <code>my_exception</code> derives from <code>std::exception</code>).</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Example 2:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum class my_error { e1=1, e2, e3 }; <i class="conum" data-value="1"></i><b>(1)</b>
throw leaf::exception(my_error::e1);</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Throws an exception of a type that derives from <code>error_id</code> and from <code>std::exception</code> (because <code>my_error</code> does not derive from <code>std::exception</code>).</td>
</tr>
</table>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
To automatically capture <code>__FILE__</code>, <code>__LINE__</code> and <code>__FUNCTION__</code> with the returned object, use <a href="#BOOST_LEAF_EXCEPTION"><code>BOOST_LEAF_EXCEPTION</code></a> instead of <code>leaf::exception</code>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="exception_to_result"><code>exception_to_result</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/capture.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... Ex, class F>
<<result<T>-deduced>> exception_to_result( F && f ) noexcept;
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>This function can be used to catch exceptions from a lower-level library and convert them to <code><a href="#result">result</a><T></code>.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>Where <code>f</code> returns a type <code>T</code>, <code>exception_to_result</code> returns <code>leaf::result<T></code>.</p>
</dd>
<dt class="hdlist1">Effects: </dt>
<dd>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Catches all exceptions, then captures <code>std::current_exception</code> in a <code>std::exception_ptr</code> object, which is <a href="#tutorial-loading">loaded</a> with the returned <code>result<T></code>.</p>
</li>
<li>
<p>Attempts to convert the caught exception, using <code>dynamic_cast</code>, to each type <code>Ex<sub>i</sub></code> in <code>Ex…​</code>. If the cast to <code>Ex<sub>i</sub></code> succeeds, the <code>Ex<sub>i</sub></code> slice of the caught exception is loaded with the returned <code>result<T></code>.</p>
</li>
</ol>
</div>
</dd>
</dl>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
An error handler that takes an argument of an exception type (that is, of a type that derives from <code>std::exception</code>) will work correctly whether the object is thrown as an exception or communicated via <a href="#new_error"><code>new_error</code></a> (or converted using <code>exception_to_result</code>).
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">int compute_answer_throws();
//Call compute_answer, convert exceptions to result<int>
leaf::result<int> compute_answer()
{
return leaf::exception_to_result<ex_type1, ex_type2>(compute_answer_throws());
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>At a later time we can invoke <a href="#try_handle_some"><code>try_handle_some</code></a> / <a href="#try_handle_all"><code>try_handle_all</code></a> as usual, passing handlers that take <code>ex_type1</code> or <code>ex_type2</code>, for example by reference:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">return leaf::try_handle_some(
[] -> leaf::result<void>
{
BOOST_LEAF_AUTO(answer, compute_answer());
//Use answer
....
return { };
},
[](ex_type1 & ex1)
{
//Handle ex_type1
....
return { };
},
[](ex_type2 & ex2)
{
//Handle ex_type2
....
return { };
},
[](std::exception_ptr const & p)
{
//Handle any other exception from compute_answer.
....
return { };
} );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#try_handle_some"><code>try_handle_some</code></a> | <a href="#result"><code>result</code></a> | <a href="#BOOST_LEAF_AUTO"><code>BOOST_LEAF_AUTO</code></a></p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
When a handler takes an argument of an exception type (that is, a type that derives from <code>std::exception</code>), if the object is thrown, the argument will be matched dynamically (using <code>dynamic_cast</code>); otherwise (e.g. after being converted by <code>exception_to_result</code>) it will be matched based on its static type only (which is the same behavior used for types that do not derive from <code>std::exception</code>).
</td>
</tr>
</table>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
See also <a href="#tutorial-exception_to_result">Converting Exceptions to <code>result<T></code></a> from the tutorial.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="make_context"><code>make_context</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/context.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... H>
context_type_from_handlers<H...> make_context() noexcept
{
return { };
}
template <class... H>
context_type_from_handlers<H...> make_context( H && ... ) noexcept
{
return { };
}
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#context_type_from_handlers"><code>context_type_from_handlers</code></a></p>
</div>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">auto ctx = leaf::make_context( <i class="conum" data-value="1"></i><b>(1)</b>
[]( e_this ) { .... },
[]( e_that ) { .... } );</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td><code>decltype(ctx)</code> is <code>leaf::context<e_this, e_that></code>.</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="make_shared_context"><code>make_shared_context</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/context.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... H>
context_ptr make_shared_context() noexcept
{
return std::make_shared<leaf_detail::polymorphic_context_impl<context_type_from_handlers<H...>>>();
}
template <class... H>
context_ptr make_shared_context( H && ... ) noexcept
{
return std::make_shared<leaf_detail::polymorphic_context_impl<context_type_from_handlers<H...>>>();
}
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#context_type_from_handlers"><code>context_type_from_handlers</code></a></p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
See also <a href="#tutorial-async">Transporting Error Objects Between Threads</a> from the tutorial.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="new_error"><code>new_error</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... Item>
error_id new_error(Item && ... item) noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Requires: </dt>
<dd>
<p>Each of the <code>Item…​</code> types must be no-throw movable.</p>
</dd>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>As if:</p>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">error_id id = <<generate-new-unique-id>>;
return id.load(std::forward<Item>(item)...);</code></pre>
</div>
</div>
</dd>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>A new <code>error_id</code> value, which is unique across the entire program.</p>
</dd>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>id.value()!=0</code>, where <code>id</code> is the returned <code>error_id</code>.</p>
</dd>
</dl>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<code>new_error</code> discards error objects which are not used in any active error-handling calling scope.
</td>
</tr>
</table>
</div>
<div class="admonitionblock caution">
<table>
<tr>
<td class="icon">
<i class="fa icon-caution" title="Caution"></i>
</td>
<td class="content">
When loaded into a <code>context</code>, an error object of a type <code>E</code> will overwrite the previously loaded object of type <code>E</code>, if any.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="on_error"><code>on_error</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/on_error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... Item>
<<unspecified-type>> on_error(Item && ... item) noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Requires: </dt>
<dd>
<p>Each of the <code>Item…​</code> types must be no-throw movable.</p>
</dd>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>All <code>item…​</code> objects are forwarded and stored, together with the value returned from <code>std::unhandled_exceptions</code>, into the returned object of unspecified type, which should be captured by <code>auto</code> and kept alive in the calling scope. When that object is destroyed, if an error has occurred since <code>on_error</code> was invoked, LEAF will process the stored items to obtain error objects to be associated with the failure.</p>
<div class="paragraph">
<p>On error, LEAF first needs to deduce an <code>error_id</code> value <code>err</code> to associate error objects with. This is done using the following logic:</p>
</div>
<div class="openblock">
<div class="content">
<div class="ulist">
<ul>
<li>
<p>If <a href="#new_error"><code>new_error</code></a> was invoked (by the calling thread) since the object returned by <code>on_error</code> was created, <code>err</code> is initialized with the value returned by <a href="#current_error"><code>current_error</code></a>;</p>
</li>
<li>
<p>Otherwise, if <code>std::unhandled_exceptions</code> returns a greater value than it returned during initialization, <code>err</code> is initialized with the value returned by <a href="#new_error"><code>new_error</code></a>;</p>
</li>
<li>
<p>Otherwise, the stored <code>item…​</code> objects are discarded and no further action is taken (no error has occurred).</p>
</li>
</ul>
</div>
</div>
</div>
<div class="paragraph">
<p>Next, LEAF proceeds similarly to:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">err.load(std::forward<Item>(item)...);</code></pre>
</div>
</div>
<div class="paragraph">
<p>The difference is that unlike <a href="#error_id::load"><code>load</code></a>, <code>on_error</code> will not overwrite any error objects already associated with <code>err</code>.</p>
</div>
</dd>
</dl>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
See <a href="#tutorial-on_error">Using <code>on_error</code></a> from the Tutorial.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="try_catch"><code>try_catch</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/handle_errors.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class TryBlock, class... H>
typename std::decay<decltype(std::declval<TryBlock>()())>::type
try_catch( TryBlock && try_block, H && ... h );
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>try_catch</code> function works similarly to <a href="#try_handle_some"><code>try_handle_some</code></a>, except that it does not use or understand the semantics of <code>result<T></code> types; instead:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>It assumes that the <code>try_block</code> throws to indicate a failure, in which case <code>try_catch</code> will attempt to find a suitable handler among <code>h…​</code>;</p>
</li>
<li>
<p>If a suitable handler isn’t found, the original exception is re-thrown using <code>throw;</code>.</p>
</li>
</ul>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
See also Five Minute Introduction <a href="#introduction-eh">Exception-Handling API</a>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="try_handle_all"><code>try_handle_all</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/handle_errors.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class TryBlock, class... H>
typename std::decay<decltype(std::declval<TryBlock>()().value())>::type
try_handle_all( TryBlock && try_block, H && ... h );
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>try_handle_all</code> function works similarly to <a href="#try_handle_some"><code>try_handle_some</code></a>, except:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>In addition, it requires that at least one of <code>h…​</code> can be used to handle any error (this requirement is enforced at compile time);</p>
</li>
<li>
<p>If the <code>try_block</code> returns some <code>result<T></code> type, it must be possible to initialize a value of type <code>T</code> with the value returned by each of <code>h…​</code>, and</p>
</li>
<li>
<p>Because it is required to handle all errors, <code>try_handle_all</code> unwraps the <code>result<T></code> object <code>r</code> returned by the <code>try_block</code>, returning <code>r.value()</code> instead of <code>r</code>.</p>
</li>
</ul>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
See also <a href="#introduction-result">Five Minute Introduction</a>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="try_handle_some"><code>try_handle_some</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/handle_errors.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class TryBlock, class... H>
typename std::decay<decltype(std::declval<TryBlock>()())>::type
try_handle_some( TryBlock && try_block, H && ... h );
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Requires: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p>The <code>try_block</code> function may not take any arguments.</p>
</li>
<li>
<p>The type <code>R</code> returned by the <code>try_block</code> function must be a <code>result<T></code> type (see <a href="#is_result_type"><code>is_result_type</code></a>). It is valid for the <code>try_block</code> to return <code>leaf::<a href="#result">result</a><T></code>, however this is not a requirement.</p>
</li>
<li>
<p>Each of the <code>h…​</code> functions:</p>
<div class="ulist">
<ul>
<li>
<p>must return a type that can be used to initialize an object of the type <code>R</code>; in case R is a <code>result<void></code> (that is, in case of success it does not communicate a value), handlers that return <code>void</code> are permitted. If such a handler is selected, the <code>try_handle_some</code> return value is initialized by <code>{}</code>;</p>
</li>
<li>
<p>may take any error objects, by value, by (<code>const</code>) reference, or as pointer (to <code>const</code>);</p>
</li>
<li>
<p>may take arguments, by value, of any predicate type: <a href="#catch_"><code>catch_</code></a>, <a href="#match"><code>match</code></a>, <a href="#match_value"><code>match_value</code></a>, <a href="#match_member"><code>match_member</code></a>, <a href="#if_not"><code>if_not</code></a>, or of any user-defined predicate type <code>Pred</code> for which <code><a href="#is_predicate">is_predicate</a><Pred>::value</code> is <code>true</code>;</p>
</li>
<li>
<p>may take an <a href="#error_info"><code>error_info</code></a> argument by <code>const &</code>;</p>
</li>
<li>
<p>may take a <a href="#diagnostic_info"><code>diagnostic_info</code></a> argument by <code>const &</code>;</p>
</li>
<li>
<p>may take a <a href="#verbose_diagnostic_info"><code>verbose_diagnostic_info</code></a> argument by <code>const &</code>.</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
</dd>
<dt class="hdlist1">Effects: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p>Creates a local <code><a href="#context">context</a><E…​></code> object <code>ctx</code>, where the <code>E…​</code> types are automatically deduced from the types of arguments taken by each of <code>h…​</code>, which guarantees that <code>ctx</code> is able to store all of the types required to handle errors.</p>
</li>
<li>
<p>Invokes the <code>try_block</code>:</p>
<div class="ulist">
<ul>
<li>
<p>if the returned object <code>r</code> indicates success <span class="underline">and</span> the <code>try_block</code> did not throw, <code>r</code> is forwarded to the caller.</p>
</li>
<li>
<p>otherwise, LEAF considers each of the <code>h…​</code> handlers, in order, until it finds one that it can supply with arguments using the error objects currently stored in <code>ctx</code>, associated with <code>r.error()</code>. The first such handler is invoked and its return value is used to initialize the return value of <code>try_handle_some</code>, which can indicate success if the handler was able to handle the error, or failure if it was not.</p>
</li>
<li>
<p>if <code>try_handle_some</code> is unable to find a suitable handler, it returns <code>r</code>.</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
</dd>
</dl>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<code>try_handle_some</code> is exception-neutral: it does not throw exceptions, however the <code>try_block</code> and any of <code>h…​</code> are permitted to throw.
</td>
</tr>
</table>
</div>
<div id="handler_selection_procedure" class="dlist">
<dl>
<dt class="hdlist1">Handler Selection Procedure: </dt>
<dd>
<div class="paragraph">
<p>A handler <code>h</code> is suitable to handle the failure reported by <code>r</code> iff <code>try_handle_some</code> is able to produce values to pass as its arguments, using the error objects currently available in <code>ctx</code>, associated with the error ID obtained by calling <code>r.error()</code>. As soon as it is determined that an argument value can not be produced, the current handler is dropped and the selection process continues with the next handler, if any.</p>
</div>
<div class="paragraph">
<p>The return value of <code>r.error()</code> must be implicitly convertible to <a href="#error_id"><code>error_id</code></a>. Naturally, the <code>leaf::result</code> template satisfies this requirement. If an external <code>result</code> type is used instead, usually <code>r.error()</code> would return a <code>std::error_code</code>, which is able to communicate LEAF error IDs; see <a href="#tutorial-interoperability">Interoperability</a>.</p>
</div>
<div class="paragraph">
<p>If <code>err</code> is the <code>error_id</code> obtained from <code>r.error()</code>, each argument <code>a<sub>i</sub></code> taken by the handler currently under consideration is produced as follows:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>If <code>a<sub>i</sub></code> is of type <code>A<sub>i</sub></code>, <code>A<sub>i</sub> const&</code> or <code>A<sub>i</sub>&</code>:</p>
<div class="openblock">
<div class="content">
<div class="ulist">
<ul>
<li>
<p>If an error object of type <code>A<sub>i</sub></code>, associated with <code>err</code>, is currently available in <code>ctx</code>, <code>a<sub>i</sub></code> is initialized with a reference to that object; otherwise</p>
</li>
<li>
<p>If <code>A<sub>i</sub></code> derives from <code>std::exception</code>, and the <code>try_block</code> throws an object <code>ex</code> of type that derives from <code>std::exception</code>, LEAF obtains <code>A<sub>i</sub>* p = dynamic_cast<A<sub>i</sub>*>(&ex)</code>. The handler is dropped if <code>p</code> is null, otherwise <code>a<sub>i</sub></code> is initialized with <code>*p</code>.</p>
</li>
<li>
<p>Otherwise the handler is dropped.</p>
</li>
</ul>
</div>
</div>
</div>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">....
auto r = leaf::try_handle_some(
[]() -> leaf::result<int>
{
return f();
},
[](leaf::e_file_name const & fn) <i class="conum" data-value="1"></i><b>(1)</b>
{
std::cerr << "File Name: \"" << fn.value << '"' << std::endl; <i class="conum" data-value="2"></i><b>(2)</b>
return 1;
} );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#e_file_name"><code>e_file_name</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>In case the <code>try_block</code> indicates a failure, this handler will be selected if <code>ctx</code> stores an <code>e_file_name</code> associated with the error. Because this is the only supplied handler, if an <code>e_file_name</code> is not available, <code>try_handle_some</code> will return the <code>leaf::result<int></code> returned by <code>f</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Print the file name, handle the error.</td>
</tr>
</table>
</div>
</li>
<li>
<p>If <code>a<sub>i</sub></code> is of type <code>A<sub>i</sub></code> <code>const*</code> or <code>A<sub>i</sub>*</code>, <code>try_handle_some</code> is always able to produce it: first it attempts to produce it as if it is taken by reference; if that fails, rather than dropping the handler, <code>a<sub>i</sub></code> is initialized with <code>0</code>.</p>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">....
try_handle_some(
[]() -> leaf::result<int>
{
return f();
},
[](leaf::e_file_name const * fn) <i class="conum" data-value="1"></i><b>(1)</b>
{
if( fn ) <i class="conum" data-value="2"></i><b>(2)</b>
std::cerr << "File Name: \"" << fn->value << '"' << std::endl;
return 1;
} );
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#e_file_name"><code>e_file_name</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>This handler can be selected to handle any error, because it takes <code>e_file_name</code> as a <code>const *</code> (and nothing else).</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>If an <code>e_file_name</code> is available with the current error, print it.</td>
</tr>
</table>
</div>
</li>
<li>
<p>If <code>a<sub>i</sub></code> is of a predicate type <code>Pred</code> (for which <code><a href="#is_predicate">is_predicate</a><Pred>::value</code> is <code>true</code>), <code>E</code> is deduced as <code>typename Pred::error_type</code>, and then:</p>
<div class="ulist">
<ul>
<li>
<p>If <code>E</code> is not <code>void</code>, and an error object <code>e</code> of type <code>E</code>, associated with <code>err</code>, is not currently stored in <code>ctx</code>, the handler is dropped; otherwise the handler is dropped if the expression <code>Pred::evaluate(e)</code> returns <code>false</code>.</p>
</li>
<li>
<p>if <code>E</code> is <code>void</code>, and a <code>std::exception</code> was not caught, the handler is dropped; otherwise the handler is dropped if the expression <code>Pred::evaluate(e)</code>, where <code>e</code> is of type <code>std::exception const &</code>, returns <code>false</code>.</p>
</li>
<li>
<p>To invoke the handler, the <code>Pred</code> argument <code>a<sub>i</sub></code> is initialized with <code>Pred{e}</code>.</p>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
See also: <a href="#predicates">Predicates</a>.
</td>
</tr>
</table>
</div>
</li>
</ul>
</div>
</li>
<li>
<p>If <code>a<sub>i</sub></code> is of type <code>error_info const &</code>, <code>try_handle_some</code> is always able to produce it.</p>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">....
try_handle_some(
[]
{
return f(); // returns leaf::result<T>
},
[](leaf::error_info const & info) <i class="conum" data-value="1"></i><b>(1)</b>
{
std::cerr << "leaf::error_info:" << std::endl << info; <i class="conum" data-value="2"></i><b>(2)</b>
return info.error(); <i class="conum" data-value="3"></i><b>(3)</b>
} );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#error_info"><code>error_info</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>This handler matches any error.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Print error information.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Return the original error, which will be returned out of <code>try_handle_some</code>.</td>
</tr>
</table>
</div>
</li>
<li>
<p>If <code>a<sub>i</sub></code> is of type <code>diagnostic_info const &</code>, <code>try_handle_some</code> is always able to produce it.</p>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">....
try_handle_some(
[]
{
return f(); // throws
},
[](leaf::diagnostic_info const & info) <i class="conum" data-value="1"></i><b>(1)</b>
{
std::cerr << "leaf::diagnostic_information:" << std::endl << info; <i class="conum" data-value="2"></i><b>(2)</b>
return info.error(); <i class="conum" data-value="3"></i><b>(3)</b>
} );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#diagnostic_info"><code>diagnostic_info</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>This handler matches any error.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Print diagnostic information, including limited information about dropped error objects.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Return the original error, which will be returned out of <code>try_handle_some</code>.</td>
</tr>
</table>
</div>
</li>
<li>
<p>If <code>a<sub>i</sub></code> is of type <code>verbose_diagnostic_info const &</code>, <code>try_handle_some</code> is always able to produce it.</p>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">....
try_handle_some(
[]
{
return f(); // throws
},
[](leaf::verbose_diagnostic_info const & info) <i class="conum" data-value="1"></i><b>(1)</b>
{
std::cerr << "leaf::verbose_diagnostic_information:" << std::endl << info; <i class="conum" data-value="2"></i><b>(2)</b>
return info.error(); <i class="conum" data-value="3"></i><b>(3)</b>
} );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#verbose_diagnostic_info"><code>verbose_diagnostic_info</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>This handler matches any error.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Print verbose diagnostic information, including values of dropped error objects.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Return the original error, which will be returned out of <code>try_handle_some</code>.</td>
</tr>
</table>
</div>
</li>
</ul>
</div>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="types">Reference: Types</h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
The contents of each Reference section are organized alphabetically.
</td>
</tr>
</table>
</div>
<hr>
<div class="sect2">
<h3 id="context"><code>context</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/context.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... E>
class context
{
context( context const & ) = delete;
context & operator=( context const & ) = delete;
public:
context() noexcept;
context( context && x ) noexcept;
~context() noexcept;
void activate() noexcept;
void deactivate() noexcept;
bool is_active() const noexcept;
void propagate() noexcept;
void print( std::ostream & os ) const;
template <class R, class... H>
R handle_error( error_id, H && ... ) const;
};
template <class... H>
using context_type_from_handlers = typename <<unspecified>>::type;
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#context::context">Constructors</a> | <a href="#context::activate"><code>activate</code></a> | <a href="#context::deactivate"><code>deactivate</code></a> | <a href="#context::is_active"><code>is_active</code></a> | <a href="#context::propagate"><code>propagate</code></a> | <a href="#context::print"><code>print</code></a> | <a href="#context::handle_error"><code>handle_error</code></a> | <a href="#context_type_from_handlers"><code>context_type_from_handlers</code></a></p>
</div>
<div class="paragraph">
<p>The <code>context</code> class template provides storage for each of the specified <code>E…​</code> types. Typically, <code>context</code> objects are not used directly; they’re created internally when the <a href="#try_handle_some"><code>try_handle_some</code></a>, <a href="#try_handle_all"><code>try_handle_all</code></a> or <a href="#try_catch"><code>try_catch</code></a> functions are invoked, instantiated with types that are automatically deduced from the types of the arguments of the passed handlers.</p>
</div>
<div class="paragraph">
<p>Independently, users can create <code>context</code> objects if they need to capture error objects and then transport them, by moving the <code>context</code> object itself.</p>
</div>
<div class="paragraph">
<p>Even in that case it is recommended that users do not instantiate the <code>context</code> template by explicitly listing the <code>E…​</code> types they want it to be able to store. Instead, use <a href="#context_type_from_handlers"><code>context_type_from_handlers</code></a> or call the <a href="#make_context"><code>make_context</code></a> function template, which deduce the correct <code>E…​</code> types from a captured list of handler function objects.</p>
</div>
<div class="paragraph">
<p>To be able to load up error objects in a <code>context</code> object, it must be activated. Activating a <code>context</code> object <code>ctx</code> binds it to the calling thread, setting thread-local pointers of the stored <code>E…​</code> types to point to the corresponding storage within <code>ctx</code>. It is possible, even likely, to have more than one active <code>context</code> in any given thread. In this case, activation/deactivation must happen in a LIFO manner. For this reason, it is best to use a <a href="#context_activator"><code>context_activator</code></a>, which relies on RAII to activate and deactivate a <code>context</code>.</p>
</div>
<div class="paragraph">
<p>When a <code>context</code> is deactivated, it detaches from the calling thread, restoring the thread-local pointers to their pre-<code>activate</code> values. Typically, at this point the stored error objects, if any, are either discarded (by default) or moved to corresponding storage in other <code>context</code> objects active in the calling thread (if available), by calling <a href="#context::propagate"><code>propagate</code></a>.</p>
</div>
<div class="paragraph">
<p>While error handling typically uses <a href="#try_handle_some"><code>try_handle_some</code></a>, <a href="#try_handle_all"><code>try_handle_all</code></a> or <a href="#try_catch"><code>try_catch</code></a>, it is also possible to handle errors by calling the member function <a href="#context::handle_error"><code>handle_error</code></a>. It takes an <a href="#error_id"><code>error_id</code></a>, and attempts to select an error handler based on the error objects stored in <code>*this</code>, associated with the passed <code>error_id</code>.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<code>context</code> objects can be moved, as long as they aren’t active.
</td>
</tr>
</table>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
Moving an active <code>context</code> results in undefined behavior.
</td>
</tr>
</table>
</div>
<hr>
<div class="sect3">
<h4 id="context::context">Constructors</h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/context.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... E>
context<E...>::context() noexcept;
template <class... E>
context<E...>::context( context && x ) noexcept;
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>The default constructor initializes an empty <code>context</code> object: it provides storage for, but does not contain any error objects.</p>
</div>
<div class="paragraph">
<p>The move constructor moves the stored error objects from one <code>context</code> to the other.</p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
Moving an active <code>context</code> object results in undefined behavior.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="context::activate"><code>activate</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/context.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... E>
void context<E...>::activate() noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Requires: </dt>
<dd>
<p><code>!<a href="#context::is_active">is_active</a>()</code>.</p>
</dd>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>Associates <code>*this</code> with the calling thread.</p>
</dd>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code><a href="#context::is_active">is_active</a>()</code>.</p>
</dd>
</dl>
</div>
<div class="paragraph">
<p>When a context is associated with a thread, thread-local pointers are set to point each <code>E…​</code> type in its store, while the previous value of each such pointer is preserved in the <code>context</code> object, so that the effect of <code>activate</code> can be undone by calling <code>deactivate</code>.</p>
</div>
<div class="paragraph">
<p>When an error object is <a href="#tutorial-loading">loaded</a>, it is moved in the last activated (in the calling thread) <code>context</code> object that provides storage for its type (note that this may or may not be the last activated <code>context</code> object). If no such storage is available, the error object is discarded.</p>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="context::deactivate"><code>deactivate</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/context.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... E>
void context<E...>::deactivate() noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Requires: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p><code><a href="#context::is_active">is_active</a>()</code>;</p>
</li>
<li>
<p><code>*this</code> must be the last activated <code>context</code> object in the calling thread.</p>
</li>
</ul>
</div>
</dd>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>Un-associates <code>*this</code> with the calling thread.</p>
</dd>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>!<a href="#context::is_active">is_active</a>()</code>.</p>
</dd>
</dl>
</div>
<div class="paragraph">
<p>When a context is deactivated, the thread-local pointers that currently point to each individual error object storage in it are restored to their original value prior to calling <a href="#context::activate"><code>activate</code></a>.</p>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="context::handle_error"><code>handle_error</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/handle_errors.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... E>
template <class R, class... H>
R context<E...>::handle_error( error_id err, H && ... h ) const;
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>This function works similarly to <a href="#try_handle_all"><code>try_handle_all</code></a>, but rather than calling a <code>try_block</code> and obtaining the <a href="#error_id"><code>error_id</code></a> from a returned <code>result</code> type, it matches error objects (stored in <code>*this</code>, associated with <code>err</code>) with a suitable error handler from the <code>h…​</code> pack.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
The caller is required to specify the return type <code>R</code>. This is because in general the supplied handlers may return different types (which must all be convertible to <code>R</code>).
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="context::is_active"><code>is_active</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/context.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... E>
bool context<E...>::is_active() const noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>true</code> if the <code>*this</code> is active in any thread, <code>false</code> otherwise.</p>
</dd>
</dl>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="context::print"><code>print</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/context.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... E>
void context<E...>::print( std::ostream & os ) const;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>Prints all error objects currently stored in <code>*this</code>, together with the unique error ID each individual error object is associated with.</p>
</dd>
</dl>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="context::propagate"><code>propagate</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/context.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... E>
void context<E...>::propagate() noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Requires: </dt>
<dd>
<p><code>!<a href="#context::is_active">is_active</a>()</code>.</p>
</dd>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>Each stored error object of some type <code>E</code> is moved into another <code>context</code> object active in the call stack that provides storage for objects of type <code>E</code>, if any, or discarded.</p>
</dd>
</dl>
</div>
<hr>
</div>
</div>
<div class="sect2">
<h3 id="context_activator"><code>context_activator</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class Ctx>
class context_activator
{
context_activator( context_activator const & ) = delete;
context_activator & operator=( context_activator const & ) = delete;
public:
explicit context_activator( Ctx & ctx ) noexcept;
context_activator( context_activator && ) noexcept;
~context_activator() noexcept;
};
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p><code>context_activator</code> is a simple class that activates and deactivates a <a href="#context"><code>context</code></a> using RAII:</p>
</div>
<div class="paragraph">
<p>If <code><a href="#context::is_active">ctx.is_active</a></code>() is <code>true</code> at the time the <code>context_activator</code> is initialized, the constructor and the destructor have no effects. Otherwise:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>The constructor stores a reference to <code>ctx</code> in <code>*this</code> and calls <code><a href="#context::activate">ctx.activate</a></code>().</p>
</li>
<li>
<p>The destructor:</p>
<div class="ulist">
<ul>
<li>
<p>Has no effects if <code>ctx.is_active()</code> is <code>false</code> (that is, it is valid to call <a href="#context::deactivate"><code>deactivate</code></a> manually, before the <code>context_activator</code> object expires);</p>
</li>
<li>
<p>Otherwise, calls <code><a href="#context::deactivate">ctx.deactivate</a></code>() and, if there are new uncaught exceptions since the constructor was called, the destructor calls <code><a href="#context::propagate">ctx.propagate</a></code>().</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="paragraph">
<p>For automatic deduction of <code>Ctx</code>, use <a href="#activate_context"><code>activate_context</code></a>.</p>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="diagnostic_info"><code>diagnostic_info</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/handle_errors.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
class diagnostic_info: public error_info
{
//Constructors unspecified
friend std::ostream & operator<<( std::ostream & os, diagnostic_info const & x );
};
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>Handlers passed to <a href="#try_handle_some"><code>try_handle_some</code></a>, <a href="#try_handle_all"><code>try_handle_all</code></a> or <a href="#try_catch"><code>try_catch</code></a> may take an argument of type <code>diagnostic_info const &</code> if they need to print diagnostic information about the error.</p>
</div>
<div class="paragraph">
<p>The message printed by <code>operator<<</code> includes the message printed by <code>error_info</code>, followed by basic information about error objects that were communicated to LEAF (to be associated with the error) for which there was no storage available in any active <a href="#context"><code>context</code></a> (these error objects were discarded by LEAF, because no handler needed them).</p>
</div>
<div class="paragraph">
<p>The additional information is limited to the type name of the first such error object, as well as their total count.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The behavior of <code>diagnostic_info</code> (and <a href="#verbose_diagnostic_info"><code>verbose_diagnostic_info</code></a>) is affected by the value of the macro <code>BOOST_LEAF_DIAGNOSTICS</code>:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>If it is 1 (the default), LEAF produces <code>diagnostic_info</code> but only if an active error handling context on the call stack takes an argument of type <code>diagnostic_info</code>;</p>
</li>
<li>
<p>If it is 0, the <code>diagnostic_info</code> functionality is stubbed out even for error handling contexts that take an argument of type <code>diagnostic_info</code>. This could shave a few cycles off the error path in some programs (but it is probably not worth it).</p>
</li>
</ul>
</div>
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="error_id"><code>error_id</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
class error_id
{
public:
error_id() noexcept;
template <class Enum>
result( Enum e, typename std::enable_if<std::is_error_code_enum<Enum>::value, Enum>::type * = 0 ) noexcept;
error_id( std::error_code const & ec ) noexcept;
int value() const noexcept;
explicit operator bool() const noexcept;
std::error_code to_error_code() const noexcept;
friend bool operator==( error_id a, error_id b ) noexcept;
friend bool operator!=( error_id a, error_id b ) noexcept;
friend bool operator<( error_id a, error_id b ) noexcept;
template <class... Item>
error_id load( Item && ... item ) const noexcept;
friend std::ostream & operator<<( std::ostream & os, error_id x );
};
bool is_error_id( std::error_code const & ec ) noexcept;
template <class... E>
error_id new_error( E && ... e ) noexcept;
error_id current_error() noexcept;
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#error_id::error_id">Constructors</a> | <a href="#error_id::value"><code>value</code></a> | <a href="#error_id::operator_bool"><code>operator bool</code></a> | <a href="#error_id::to_error_code"><code>to_error_code</code></a> | <a href="#error_id::comparison_operators"><code>operator==</code>, <code>!=</code>, <code><</code></a> | <a href="#error_id::load"><code>load</code></a> | <a href="#is_error_id"><code>is_error_id</code></a> | <a href="#new_error"><code>new_error</code></a> | <a href="#current_error"><code>current_error</code></a></p>
</div>
<div class="paragraph">
<p>Values of type <code>error_id</code> identify a specific occurrence of a failure across the entire program. They can be copied, moved, assigned to, and compared to other <code>error_id</code> objects. They’re as efficient as an <code>int</code>.</p>
</div>
<hr>
<div class="sect3">
<h4 id="error_id::error_id">Constructors</h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
error_id::error_id() noexcept = default;
template <class Enum>
error_id::error_id( Enum e, typename std::enable_if<std::is_error_code_enum<Enum>::value, Enum>::type * = 0 ) noexcept;
error_id::error_id( std::error_code const & ec ) noexcept;
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>A default-initialized <code>error_id</code> object does not represent a specific failure. It compares equal to any other default-initialized <code>error_id</code> object. All other <code>error_id</code> objects identify a specific occurrence of a failure.</p>
</div>
<div class="admonitionblock caution">
<table>
<tr>
<td class="icon">
<i class="fa icon-caution" title="Caution"></i>
</td>
<td class="content">
When using an object of type <code>error_id</code> to initialize a <code>result<T></code> object, it will be initialized in error state, even when passing a default-initialized <code>error_id</code> value.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Converting an <code>error_id</code> object to <code>std::error_code</code> uses an unspecified <code>std::error_category</code> which LEAF recognizes. This allows an <code>error_id</code> to be transported through interfaces that work with <code>std::error_code</code>. The <code>std::error_code</code> constructor allows the original <code>error_id</code> to be restored.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
To check if a given <code>std::error_code</code> is actually carrying an <code>error_id</code>, use <a href="#is_error_id"><code>is_error_id</code></a>.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Typically, users create new <code>error_id</code> objects by invoking <a href="#new_error"><code>new_error</code></a>. The constructor that takes <code>std::error_code</code>, and the one that takes a type <code>Enum</code> for which <code>std::is_error_code_enum<Enum>::value</code> is <code>true</code>, have the following effects:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>If <code>ec.value()</code> is <code>0</code>, the effect is the same as using the default constructor.</p>
</li>
<li>
<p>Otherwise, if <code><a href="#is_error_id">is_error_id</a>(ec)</code> is <code>true</code>, the original <code>error_id</code> value is used to initialize <code>*this</code>;</p>
</li>
<li>
<p>Otherwise, <code>*this</code> is initialized by the value returned by <a href="#new_error"><code>new_error</code></a>, while <code>ec</code> is passed to <code>load</code>, which enables handlers used with <code>try_handle_some</code>, <code>try_handle_all</code> or <code>try_catch</code> to receive it as an argument of type <code>std::error_code</code>.</p>
</li>
</ul>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="is_error_id"><code>is_error_id</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
bool is_error_id( std::error_code const & ec ) noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>true</code> if <code>ec</code> uses the LEAF-specific <code>std::error_category</code> that identifies it as carrying an error ID rather than another error code; otherwise returns <code>false</code>.</p>
</dd>
</dl>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="error_id::load"><code>load</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... Item>
error_id error_id::load( Item && ... item ) const noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Requires: </dt>
<dd>
<p>Each of the <code>Item…​</code> types must be no-throw movable.</p>
</dd>
<dt class="hdlist1">Effects: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p>If <code>value()==0</code>, all of <code>item…​</code> are discarded and no further action is taken.</p>
</li>
<li>
<p>Otherwise, what happens with each <code>item</code> depends on its type:</p>
<div class="ulist">
<ul>
<li>
<p>If it is a function that takes a single argument of some type <code>E &</code>, that function is called with the object of type <code>E</code> currently associated with <code>*this</code>. If no such object exists, a default-initialized object is associated with <code>*this</code> and then passed to the function.</p>
</li>
<li>
<p>If it is a function that takes no arguments, than function is called to obtain an error object, which is associated with <code>*this</code>.</p>
</li>
<li>
<p>Otherwise, the <code>item</code> itself is assumed to be an error object, which is associated with <code>*this</code>.</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
</dd>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>*this</code>.</p>
</dd>
</dl>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<code>load</code> discards error objects which are not used in any active error-handling calling scope.
</td>
</tr>
</table>
</div>
<div class="admonitionblock caution">
<table>
<tr>
<td class="icon">
<i class="fa icon-caution" title="Caution"></i>
</td>
<td class="content">
When loaded into a <code>context</code>, an error object of a type <code>E</code> will overwrite the previously loaded object of type <code>E</code>, if any.
</td>
</tr>
</table>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">See also: </dt>
<dd>
<p><a href="#tutorial-loading">Loading of Error Objects</a>.</p>
</dd>
</dl>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="error_id::comparison_operators"><code>operator==</code>, <code>!=</code>, <code><</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
friend bool operator==( error_id a, error_id b ) noexcept;
friend bool operator!=( error_id a, error_id b ) noexcept;
friend bool operator<( error_id a, error_id b ) noexcept;
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>These functions have the usual semantics, comparing <code>a.value()</code> and <code>b.value()</code>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
The exact strict weak ordering implemented by <code>operator<</code> is not specified. In particular, if for two <code>error_id</code> objects <code>a</code> and <code>b</code>, <code>a < b</code> is true, it does not follow that the failure identified by <code>a</code> ocurred earlier than the one identified by <code>b</code>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="error_id::operator_bool"><code>operator bool</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
explicit error_id::operator bool() const noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>As if <code>return value()!=0</code>.</p>
</dd>
</dl>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="error_id::to_error_code"><code>to_error_code</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
std::error_code error_id::to_error_code() const noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>Returns a <code>std::error_code</code> with the same <code>value()</code> as <code>*this</code>, using an unspecified <code>std::error_category</code>.</p>
</dd>
</dl>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
The returned object can be used to initialize an <code>error_id</code>, in which case the original <code>error_id</code> value will be restored.
</td>
</tr>
</table>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
Use <a href="#is_error_id"><code>is_error_id</code></a> to check if a given <code>std::error_code</code> carries an <code>error_id</code>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="error_id::value"><code>value</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
int error_id::value() const noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p>If <code>*this</code> was initialized using the default constructor, returns 0.</p>
</li>
<li>
<p>Otherwise returns an <code>int</code> that is guaranteed to not be 0: a program-wide unique identifier of the failure.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
<hr>
</div>
</div>
<div class="sect2">
<h3 id="error_monitor"><code>error_monitor</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/on_error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
class error_monitor
{
public:
error_monitor() noexcept;
error_id check() const noexcept;
error_id assigned_error_id( E && ... e ) const noexcept;
};
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>This class helps obtain an <a href="#error_id"><code>error_id</code></a> to associate error objects with, when augmenting failures communicated using LEAF through uncooperative APIs that do not use LEAF to report errors (and therefore do not return an <code>error_id</code> on error).</p>
</div>
<div class="paragraph">
<p>The common usage of this class is as follows:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">error_code compute_value( int * out_value ) noexcept; <i class="conum" data-value="1"></i><b>(1)</b>
leaf::error<int> augmenter() noexcept
{
leaf::error_monitor cur_err; <i class="conum" data-value="2"></i><b>(2)</b>
int val;
auto ec = compute_value(&val);
if( failure(ec) )
return cur_err.assigned_error_id().load(e1, e2, ...); <i class="conum" data-value="3"></i><b>(3)</b>
else
return val; <i class="conum" data-value="4"></i><b>(4)</b>
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Uncooperative third-party API that does not use LEAF, but may result in calling a user callback that does use LEAF. In case our callback reports a failure, we’ll augment it with error objects available in the calling scope, even though <code>compute_value</code> can not communicate an <a href="#error_id"><code>error_id</code></a>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Initialize an <code>error_monitor</code> object.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>The call to <code>compute_value</code> has failed:
<div class="ulist">
<ul>
<li>
<p>If <a href="#new_error"><code>new_error</code></a> was invoked (by the calling thread) after the <code>augment</code> object was initialized, <code>assigned_error_id</code> returns the last <code>error_id</code> returned by <code>new_error</code>. This would be the case if the failure originates in our callback (invoked internally by <code>compute_value</code>).</p>
</li>
<li>
<p>Else, <code>assigned_error_id</code> invokes <code>new_error</code> and returns that <code>error_id</code>.</p>
</li>
</ul>
</div></td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>The call was successful, return the computed value.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The <code>check</code> function works similarly, but instead of invoking <code>new_error</code> it returns a defaul-initialized <code>error_id</code>.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
See <a href="#tutorial-on_error_in_c_callbacks">Using <code>error_monitor</code> to Report Arbitrary Errors from C-callbacks</a>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="e_api_function"><code>e_api_function</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/common.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
struct e_api_function {char const * value;};
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>e_api_function</code> type is designed to capture the name of the API function that failed. For example, if you’re reporting an error from <code>fread</code>, you could use <code>leaf::e_api_function {"fread"}</code>.</p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
The passed value is stored as a C string (<code>char const *</code>), so <code>value</code> should only be initialized with a string literal.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="e_at_line"><code>e_at_line</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/common.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
struct e_at_line { int value; };
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p><code>e_at_line</code> can be used to communicate the line number when reporting errors (for example parse errors) about a text file.</p>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="e_errno"><code>e_errno</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/common.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
struct e_errno
{
int value;
friend std::ostream & operator<<( std::ostream & os, e_errno const & err );
};
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>To capture <code>errno</code>, use <code>e_errno</code>. When printed in automatically-generated diagnostic messages, <code>e_errno</code> objects use <code>strerror</code> to convert the <code>errno</code> code to string.</p>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="e_file_name"><code>e_file_name</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/common.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
struct e_file_name { std::string value; };
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>When a file operation fails, you could use <code>e_file_name</code> to store the name of the file.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
It is probably better to define your own file name wrappers to avoid clashes if different modules all use <code>leaf::e_file_name</code>. It is best to use a descriptive name that clarifies what kind of file name it is (e.g. <code>e_source_file_name</code>, <code>e_destination_file_name</code>), or at least define <code>e_file_name</code> in a given module’s namespace.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="e_LastError"><code>e_LastError</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/common.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
namespace windows
{
struct e_LastError
{
unsigned value;
friend std::ostream & operator<<( std::ostream & os, e_LastError const & err );
};
}
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p><code>e_LastError</code> is designed to communicate <code>GetLastError()</code> values on Windows.</p>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="e_source_location"><code>e_source_location</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
struct e_source_location
{
char const * const file;
int const line;
char const * const function;
friend std::ostream & operator<<( std::ostream & os, e_source_location const & x );
};
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>The <a href="#BOOST_LEAF_NEW_ERROR"><code>BOOST_LEAF_NEW_ERROR</code></a>, <a href="#BOOST_LEAF_EXCEPTION"><code>BOOST_LEAF_EXCEPTION</code></a> and <a href="#BOOST_LEAF_THROW_EXCEPTION"><code>BOOST_LEAF_THROW_EXCEPTION</code></a> macros capture <code>__FILE__</code>, <code>__LINE__</code> and <code>__FUNCTION__</code> into a <code>e_source_location</code> object.</p>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="e_type_info_name"><code>e_type_info_name</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/common.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
struct e_type_info_name { char const * value; };
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p><code>e_type_info_name</code> is designed to store the return value of <code>std::type_info::name</code>.</p>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="error_info"><code>error_info</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/handle_errors.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
class error_info
{
//Constructors unspecified
public:
error_id error() const noexcept;
bool exception_caught() const noexcept;
std::exception const * exception() const noexcept;
friend std::ostream & operator<<( std::ostream & os, error_info const & x );
};
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>Handlers passed to error-handling functions such as <a href="#try_handle_some"><code>try_handle_some</code></a>, <a href="#try_handle_all"><code>try_handle_all</code></a> or <a href="#try_catch"><code>try_catch</code></a> may take an argument of type <code>error_info const &</code> to receive generic information about the error being handled.</p>
</div>
<div class="paragraph">
<p>The <code>error</code> member function returns the program-wide unique <a href="#error_id"><code>error_id</code></a> of the error.</p>
</div>
<div class="paragraph">
<p>The <code>exception_caught</code> member function returns <code>true</code> if the handler that received <code>*this</code> is being invoked to handle an exception, <code>false</code> otherwise.</p>
</div>
<div class="paragraph">
<p>If handling an exception, the <code>exception</code> member function returns a pointer to the <code>std::exception</code> subobject of the caught exception, or <code>0</code> if that exception could not be converted to <code>std::exception</code>.</p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
It is illegal to call the <code>exception</code> member function unless <code>exception_caught()</code> is <code>true</code>.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The <code>operator<<</code> overload prints diagnostic information about each error object currently stored in the <a href="#context"><code>context</code></a> local to the <a href="#try_handle_some"><code>try_handle_some</code></a>, <a href="#try_handle_all"><code>try_handle_all</code></a> or <a href="#try_catch"><code>try_catch</code></a> scope that invoked the handler, but only if it is associated with the <a href="#error_id"><code>error_id</code></a> returned by <code>error()</code>.</p>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="polymorphic_context"><code>polymorphic_context</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
class polymorphic_context
{
protected:
polymorphic_context() noexcept;
~polymorphic_context() noexcept;
public:
virtual void activate() noexcept = 0;
virtual void deactivate() noexcept = 0;
virtual bool is_active() const noexcept = 0;
virtual void propagate() noexcept = 0;
virtual void print( std::ostream & ) const = 0;
};
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>polymorphic_context</code> class is an abstract base type which can be used to erase the type of the exact instantiation of the <a href="#context"><code>context</code></a> class template used. See <a href="#make_shared_context"><code>make_shared_context</code></a>.</p>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="result"><code>result</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/result.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class T>
class result
{
public:
result() noexcept;
result( T && v ) noexcept;
result( T const & v );
template <class U>
result( U &&, <<enabled_if_T_can_be_inited_with_U>> );
result( error_id err ) noexcept;
result( std::shared_ptr<polymorphic_context> && ctx ) noexcept;
template <class Enum>
result( Enum e, typename std::enable_if<std::is_error_code_enum<Enum>::value, Enum>::type * = 0 ) noexcept;
result( std::error_code const & ec ) noexcept;
result( result && r ) noexcept;
template <class U>
result( result<U> && r ) noexcept;
result & operator=( result && r ) noexcept;
template <class U>
result & operator=( result<U> && r ) noexcept;
explicit operator bool() const noexcept;
T const & value() const;
T & value();
T const & operator*() const;
T & operator*();
T const * operator->() const;
T * operator->();
<<unspecified-type>> error() noexcept;
template <class... Item>
error_id load( Item && ... item ) noexcept;
};
template <>
class result<void>
{
public:
result() noexcept;
result( error_id err ) noexcept;
result( std::shared_ptr<polymorphic_context> && ctx ) noexcept;
template <class Enum>
result( Enum e, typename std::enable_if<std::is_error_code_enum<Enum>::value, Enum>::type * = 0 ) noexcept;
result( std::error_code const & ec ) noexcept;
result( result && r ) noexcept;
template <class U>
result( result<U> && r ) noexcept;
result & operator=( result && r ) noexcept;
template <class U>
result & operator=( result<U> && r ) noexcept;
explicit operator bool() const noexcept;
void value() const;
<<unspecified-type>> error() noexcept;
template <class... Item>
error_id load( Item && ... item ) noexcept;
};
struct bad_result: std::exception { };
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result::result">Constructors</a> | <a href="#result::operator_eq"><code>operator=</code></a> | <a href="#result::operator_bool"><code>operator bool</code></a> | <a href="#result::value"><code>value</code>, <code>operator*</code>, <code>-></code></a> | <a href="#result::error"><code>error</code></a> | <a href="#result::load"><code>load</code></a></p>
</div>
<div class="paragraph">
<p>The <code>result<T></code> type can be returned by functions which produce a value of type <code>T</code> but may fail doing so.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Requires: </dt>
<dd>
<p><code>T</code> must be movable, and its move constructor may not throw.</p>
</dd>
<dt class="hdlist1">Invariant: </dt>
<dd>
<p>A <code>result<T></code> object is in one of three states:</p>
<div class="ulist">
<ul>
<li>
<p>Value state, in which case it contains an object of type <code>T</code>, and <code><a href="#result::value">value</a></code>/<code><a href="#result::value">operator*</a></code>/<code><a href="#result::value">operator-></a></code> can be used to access the contained value.</p>
</li>
<li>
<p>Error state, in which case it contains an error ID, and calling <code><a href="#result::value">value</a></code>/<code><a href="#result::value">operator*</a></code>/<code><a href="#result::value">operator-></a></code> throws <code>leaf::bad_result</code>.</p>
</li>
<li>
<p>Error-capture state, which is the same as the Error state, but in addition to the error ID, it holds a <code>std::shared_ptr<<a href="#polymorphic_context">polymorphic_context</a>></code>.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
<div class="paragraph">
<p><code>result<T></code> objects are nothrow-moveable but are not copyable.</p>
</div>
<hr>
<div class="sect3">
<h4 id="result::result">Constructors</h4>
<div class="openblock">
<div class="content">
<div class="listingblock">
<div class="title">#include <boost/leaf/result.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class T>
result<T>::result() noexcept;
template <class T>
result<T>::result( T && v ) noexcept; <i class="conum" data-value="1"></i><b>(1)</b>
template <class T>
result<T>::result( T const & v ); <i class="conum" data-value="1"></i><b>(1)</b>
template <class U>
result<T>::result( U && u, <<enabled_if_T_can_be_inited_with_U>> ); <i class="conum" data-value="2"></i><b>(2)</b>
template <class T>
result<T>::result( leaf::error_id err ) noexcept;
template <class T>
template <class Enum>
result<T>::result( Enum e, typename std::enable_if<std::is_error_code_enum<Enum>::value, Enum>::type * = 0 ) noexcept;
template <class T>
result<T>::result( std::error_code const & ec ) noexcept;
template <class T>
result<T>::result( std::shared_ptr<polymorphic_context> && ctx ) noexcept;
template <class T>
result<T>::result( result && ) noexcept;
template <class T>
template <class U>
result<T>::result( result<U> && ) noexcept;
} }</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Not available if <code>T</code> is <code>void</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Available if an object of type <code>T</code> can be initialized with <code>std::forward<U>(u)</code>. This is to enable e.g. <code>result<std::string></code> to be initialized with a string literal.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Requires: </dt>
<dd>
<p><code>T</code> must be movable, and its move constructor may not throw; or <code>void</code>.</p>
</dd>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>Establishes the <code>result<T></code> invariant:</p>
<div class="openblock">
<div class="content">
<div class="ulist">
<ul>
<li>
<p>To get a <code>result<T></code> in <a href="#result">Value state</a>, initialize it with an object of type <code>T</code> or use the default constructor.</p>
</li>
<li>
<p>To get a <code>result<T></code> in <a href="#result">Error state</a>, initialize it with:</p>
<div class="ulist">
<ul>
<li>
<p>an <a href="#error_id"><code>error_id</code></a> object.</p>
<div class="admonitionblock caution">
<table>
<tr>
<td class="icon">
<i class="fa icon-caution" title="Caution"></i>
</td>
<td class="content">
Initializing a <code>result<T></code> with a default-initialized <code>error_id</code> object (for which <code>.value()</code> returns <code>0</code>) will still result in <a href="#result">Error state</a>!
</td>
</tr>
</table>
</div>
</li>
<li>
<p>a <code>std::error_code</code> object.</p>
</li>
<li>
<p>an object of type <code>Enum</code> for which <code>std::is_error_code_enum<Enum>::value</code> is <code>true</code>.</p>
</li>
</ul>
</div>
</li>
<li>
<p>To get a <code>result<T></code> in <a href="#result">Error-capture state</a>, initialize it with a <code>std::shared_ptr<<a href="#polymorphic_context">polymorphic_context</a>></code> (which can be obtained by calling e.g. <a href="#make_shared_context"><code>make_shared_context</code></a>).</p>
</li>
</ul>
</div>
</div>
</div>
<div class="paragraph">
<p>When a <code>result</code> object is initialized with a <code>std::error_code</code> object, it is used to initialize an <code>error_id</code> object, then the behavior is the same as if initialized with <code>error_id</code>.</p>
</div>
</dd>
<dt class="hdlist1">Throws: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p>Initializing the <code>result<T></code> in Value state may throw, depending on which constructor of <code>T</code> is invoked;</p>
</li>
<li>
<p>Other constructors do not throw.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
A <code>result</code> that is in value state converts to <code>true</code> in boolean contexts. A <code>result</code> that is not in value state converts to <code>false</code> in boolean contexts.
</td>
</tr>
</table>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<code>result<T></code> objects are nothrow-moveable but are not copyable.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="result::error"><code>error</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/result.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... E>
<<unspecified-type>> result<T>::error() noexcept;
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>Returns: A proxy object of unspecified type, implicitly convertible to any instance of the <code>result</code> class template, as well as to <a href="#error_id"><code>error_id</code></a>.</p>
</div>
<div class="ulist">
<ul>
<li>
<p>If the proxy object is converted to some <code>result<U></code>:</p>
<div class="ulist">
<ul>
<li>
<p>If <code>*this</code> is in <a href="#result">Value state</a>, returns <code>result<U>(error_id())</code>.</p>
</li>
<li>
<p>Otherwise the state of <code>*this</code> is moved into the returned <code>result<U></code>.</p>
</li>
</ul>
</div>
</li>
<li>
<p>If the proxy object is converted to an <code>error_id</code>:</p>
<div class="ulist">
<ul>
<li>
<p>If <code>*this</code> is in <a href="#result">Value state</a>, returns a default-initialized <a href="#error_id"><code>error_id</code></a> object.</p>
</li>
<li>
<p>If <code>*this</code> is in <a href="#result">Error-capture state</a>, all captured error objects are <a href="#tutorial-loading">loaded</a> in the calling thread, and the captured <code>error_id</code> value is returned.</p>
</li>
<li>
<p>If <code>*this</code> is in <a href="#result">Error state</a>, returns the stored <code>error_id</code>.</p>
</li>
</ul>
</div>
</li>
<li>
<p>If the proxy object is not used, the state of <code>*this</code> is not modified.</p>
</li>
</ul>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
The returned proxy object refers to <code>*this</code>; avoid holding on to it.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="result::load"><code>load</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/result.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class T>
template <class... Item>
error_id result<T>::load( Item && ... item ) noexcept;
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>This member function is designed for use in <code>return</code> statements in functions that return <code>result<T></code> to forward additional error objects to the caller.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>As if <code>error_id(this->error()).load(std::forward<Item>(item)…​)</code>.</p>
</dd>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>*this</code>.</p>
</dd>
</dl>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="result::operator_eq"><code>operator=</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/result.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class T>
result<T> & result<T>::operator=( result && ) noexcept;
template <class T>
template <class U>
result<T> & result<T>::operator=( result<U> && ) noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>Destroys <code>*this</code>, then re-initializes it as if using the appropriate <code>result<T></code> constructor. Basic exception-safety guarantee.</p>
</dd>
</dl>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="result::operator_bool"><code>operator bool</code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/result.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class T>
result<T>::operator bool() const noexcept;
} }</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>If <code>*this</code> is in <a href="#result">value state</a>, returns <code>true</code>, otherwise returns <code>false</code>.</p>
</dd>
</dl>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="result::value"><code>value</code>, <code>operator*</code>, <code>-></code></h4>
<div class="listingblock">
<div class="title">#include <boost/leaf/result.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
void result<void>::value() const; <i class="conum" data-value="1"></i><b>(1)</b>
template <class T>
T const & result<T>::value() const; <i class="conum" data-value="2"></i><b>(2)</b>
template <class T>
T & result<T>::value();
template <class T>
T const & result<T>::operator*() const; <i class="conum" data-value="2"></i><b>(2)</b>
template <class T>
T & result<T>::operator*();
template <class T>
T const * result<T>::operator->() const; <i class="conum" data-value="2"></i><b>(2)</b>
template <class T>
T * result<T>::operator->(); <i class="conum" data-value="2"></i><b>(2)</b>
struct bad_result: std::exception { };
} }</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Only when <code>T</code> is <code>void</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Only when <code>T</code> is not <code>void</code>.</td>
</tr>
</table>
</div>
<div id="result::bad_result" class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>If <code>*this</code> is in <a href="#result">value state</a>, returns a reference (or pointer) to the stored value, otherwise throws <code>bad_result</code>.</p>
</dd>
</dl>
</div>
<hr>
</div>
</div>
<div class="sect2">
<h3 id="verbose_diagnostic_info"><code>verbose_diagnostic_info</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/handle_errors.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
class verbose_diagnostic_info: public error_info
{
//Constructors unspecified
friend std::ostream & operator<<( std::ostream & os, verbose_diagnostic_info const & x );
};
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>Handlers passed to error-handling functions such as <a href="#try_handle_some"><code>try_handle_some</code></a>, <a href="#try_handle_all"><code>try_handle_all</code></a> or <a href="#try_catch"><code>try_catch</code></a> may take an argument of type <code>verbose_diagnostic_info const &</code> if they need to print diagnostic information about the error.</p>
</div>
<div class="paragraph">
<p>The message printed by <code>operator<<</code> includes the message printed by <code>error_info</code>, followed by information about error objects that were communicated to LEAF (to be associated with the error) for which there was no storage available in any active <a href="#context"><code>context</code></a> (these error objects were discarded by LEAF, because no handler needed them).</p>
</div>
<div class="paragraph">
<p>The additional information includes the types and the values of all such error objects.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The behavior of <code>verbose_diagnostic_info</code> (and <a href="#diagnostic_info"><code>diagnostic_info</code></a>) is affected by the value of the macro <code>BOOST_LEAF_DIAGNOSTICS</code>:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>If it is 1 (the default), LEAF produces <code>verbose_diagnostic_info</code> but only if an active error handling context on the call stack takes an argument of type <code>verbose_diagnostic_info</code>;</p>
</li>
<li>
<p>If it is 0, the <code>verbose_diagnostic_info</code> functionality is stubbed out even for error handling contexts that take an argument of type <code>verbose_diagnostic_info</code>. This could save some cycles on the error path in some programs (but is probably not worth it).</p>
</li>
</ul>
</div>
</td>
</tr>
</table>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
Using <code>verbose_diagnostic_info</code> will likely allocate memory dynamically.
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="predicates">Reference: Predicates</h2>
<div class="sectionbody">
<div class="paragraph">
<p>A predicate is a special type of error handler argument which enables the <a href="#handler_selection_procedure">handler selection procedure</a> to consider the <em>value</em> of available error objects, not only their type; see <a href="#tutorial-predicates">Using Predicates to Handle Errors</a>.</p>
</div>
<div class="paragraph">
<p>The following predicates are available:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="#match"><code>match</code></a></p>
</li>
<li>
<p><a href="#match_value"><code>match_value</code></a></p>
</li>
<li>
<p><a href="#match_member"><code>match_member</code></a></p>
</li>
<li>
<p><a href="#catch_"><code>catch_</code></a></p>
</li>
<li>
<p><a href="#if_not"><code>if_not</code></a></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>In addition, any user-defined type <code>Pred</code> for which <code><a href="#is_predicate">is_predicate</a><Pred>::value</code> is <code>true</code> is treated as a predicate. In this case, it is required that:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>Pred</code> defines an accessible member type <code>error_type</code> to specify the error object type it requires;</p>
</li>
<li>
<p><code>Pred</code> defines an accessible static member function <code>evaluate</code>, which returns a boolean type, and can be invoked with an object of type <code>error_type const &</code>;</p>
</li>
<li>
<p>A <code>Pred</code> instance can be initialized with an object of type <code>error_type</code>.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>When an error handler takes an argument of a predicate type <code>Pred</code>, the <a href="#handler_selection_procedure">handler selection procedure</a> drops the handler if an error object <code>e</code> of type <code>Pred::error_type</code> is not available. Otherwise, the handler is dropped if <code>Pred::evaluate(e)</code> returns <code>false</code>. If the handler is invoked, the <code>Pred</code> argument is initialized with <code>Pred{e}</code>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Predicates are evaluated before the error handler is invoked, and so they may not access dynamic state (of course the error handler itself can access dynamic state, e.g. by means of lambda expression captures).
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Example 1:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum class my_error { e1 = 1, e2, e3 };
struct my_pred
{
using error_type = my_error; <i class="conum" data-value="1"></i><b>(1)</b>
static bool evaluate(my_error) noexcept; <i class="conum" data-value="2"></i><b>(2)</b>
my_error matched; <i class="conum" data-value="3"></i><b>(3)</b>
}
namespace boost { namespace leaf {
template <>
struct is_predicate<my_pred>: std::true_type
{
};
} }</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>This predicate requires an error object of type <code>my_error</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>The handler selection procedure will call this function with an object <code>e</code> of type <code>my_error</code> to evaluate the predicate…​</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>…​and if successful, initialize the <code>my_pred</code> error handler argument with <code>my_pred{e}</code>.</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Example 2:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct my_pred
{
using error_type = leaf::e_errno; <i class="conum" data-value="1"></i><b>(1)</b>
static bool evaluate(leaf::e_errno const &) noexcept; <i class="conum" data-value="2"></i><b>(2)</b>
leaf::e_errno const & matched; <i class="conum" data-value="3"></i><b>(3)</b>
}
namespace boost { namespace leaf {
template <>
struct is_predicate<my_pred>: std::true_type
{
};
} }</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>This predicate requires an error object of type <a href="#e_errno"><code>e_errno</code></a>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>The handler selection procedure will call this function with an object <code>e</code> of type <code>e_errno</code> to evaluate the predicate…​</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>…​and if successful, initialize the <code>my_pred</code> error handler argument with <code>my_pred{e}</code>.</td>
</tr>
</table>
</div>
<hr>
<div class="sect2">
<h3 id="catch_"><code>catch_</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/pred.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class... Ex>
struct catch_
{
std::exception const & matched;
// Other members not specified
};
template <class Ex>
struct catch_<Ex>
{
Ex const & matched;
// Other members not specified
};
template <class... Ex>
struct is_predicate<catch_<Ex...>>: std::true_type
{
};
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#is_predicate"><code>is_predicate</code></a></p>
</div>
<div class="paragraph">
<p>When an error handler takes an argument of type that is an instance of the <code>catch_</code> template, the <a href="#handler_selection_procedure">handler selection procedure</a> first checks if a <code>std::exception</code> was caught. If not, the handler is dropped. Otherwise, the handler is dropped if the caught <code>std::exception</code> can not be <code>dynamic_cast</code> to any of the specified types <code>Ex…​</code>.</p>
</div>
<div class="paragraph">
<p>If the error handler is invoked, the <code>matched</code> member can be used to access the exception object.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
See also: <a href="#tutorial-predicates">Using Predicates to Handle Errors</a>.
</td>
</tr>
</table>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
While <code>catch_</code> requires that the caught exception object is of type that derives from <code>std::exception</code>, it is not required that the <code>Ex…​</code> types derive from <code>std::exception</code>.
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Example 1:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct ex1: std::exception { };
struct ex2: std::exception { };
leaf::try_catch(
[]
{
return f(); // throws
},
[](leaf::catch_<ex1, ex2> c)
{ <i class="conum" data-value="1"></i><b>(1)</b>
assert(dynamic_cast<ex1 const *>(&c.matched) || dynamic_cast<ex2 const *>(&c.matched));
....
} );</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>The handler is selected if <code>f</code> throws an exception of type <code>ex1</code> or <code>ex2</code>.</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Example 2:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct ex1: std::exception { };
leaf::try_handle_some(
[]
{
return f(); // returns leaf::result<T>
},
[](ex1 & e)
{ <i class="conum" data-value="1"></i><b>(1)</b>
....
} );</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>The handler is selected if <code>f</code> throws an exception of type <code>ex1</code>. Notice that if we’re interested in only one exception type, as long as that type derives from <code>std::exception</code>, the use of <code>catch_</code> is not required.</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="if_not"><code>if_not</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/pred.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class P>
struct if_not
{
<<deduced>> matched;
// Other members not specified
};
template <class P>
struct is_predicate<if_not<P>>: std::true_type
{
};
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#is_predicate"><code>is_predicate</code></a></p>
</div>
<div class="paragraph">
<p>When an error handler takes an argument of type <code>if_not<P></code>, where <code>P</code> is another predicate type, the <a href="#handler_selection_procedure">handler selection procedure</a> first checks if an error object of the type <code>E</code> required by <code>P</code> is available. If not, the handler is dropped. Otherwise, the handler is dropped if <code>P</code> evaluates to <code>true</code>.</p>
</div>
<div class="paragraph">
<p>If the error handler is invoked, <code>matched</code> can be used to access the matched object <code>E</code>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
See also <a href="#tutorial-predicates">Using Predicates to Handle Errors</a>.
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum class my_enum { e1, e2, e3 };
leaf::try_handle_some(
[]
{
return f(); // returns leaf::result<T>
},
[]( leaf::if_not<leaf::match<my_enum, my_enum::e1, my_enum::e2>> )
{ <i class="conum" data-value="1"></i><b>(1)</b>
....
} );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#try_handle_some"><code>try_handle_some</code></a> | <a href="#match"><code>match</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>The handler is selected if an object of type <code>my_enum</code>, which <span class="underline"><strong>does not</strong></span> compare equal to <code>e1</code> or to <code>e2</code>, <span class="underline"><strong>is</strong></span> associated with the detected error.</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="match"><code>match</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/pred.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class E, auto... V>
class match
{
<<deduced>> matched;
// Other members not specified
};
template <class E, auto... V>
struct is_predicate<match<E, V...>>: std::true_type
{
};
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#is_predicate"><code>is_predicate</code></a></p>
</div>
<div class="paragraph">
<p>When an error handler takes an argument of type <code>match<E, V…​></code>, the <a href="#handler_selection_procedure">handler selection procedure</a> first checks if an error object <code>e</code> of type <code>E</code> is available. If it is not available, the handler is dropped. Otherwise, the handler is dropped if the following condition is not met:</p>
</div>
<div class="paragraph text-center">
<p><code>p<sub>1</sub> || p<sub>2</sub> || …​ p<sub>n</sub></code>.</p>
</div>
<div class="paragraph">
<p>Generally, <code>p<sub>i</sub></code> is equivalent to <code>e == V<sub>i</sub></code>, except if <code>V<sub>i</sub></code> is pointer to a function</p>
</div>
<div class="paragraph text-center">
<p><code>bool (*V<sub>i</sub>)(T x)</code>.</p>
</div>
<div class="paragraph">
<p>In this case it is required that <code>V<sub>i</sub> != 0</code> and that <code>x</code> can be initialized with <code>E const &</code>, and <code>p<sub>i</sub></code> is equivalent to:</p>
</div>
<div class="paragraph text-center">
<p><code>V<sub>i</sub>(e)</code>.</p>
</div>
<div id="category" class="paragraph">
<p>In particular, it is valid to pass pointer to the function <code>leaf::category<Enum></code> for any <code>V<sub>i</sub></code>, where:</p>
</div>
<div class="paragraph text-center">
<p><code>std::is_error_code_enum<Enum>::value || std::is_error_condition_enum<Enum>::value</code>.</p>
</div>
<div class="paragraph">
<p>In this case, <code>p<sub>i</sub></code> is equivalent to:</p>
</div>
<div class="paragraph text-center">
<p><code>&e.category() == &std::error_code(Enum{}).category()</code>.</p>
</div>
<div class="paragraph">
<p>If the error handler is invoked, <code>matched</code> can be used to access <code>e</code>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
See also <a href="#tutorial-predicates">Using Predicates to Handle Errors</a>.
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Example 1: Handling of a subset of enum values.</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum class my_enum { e1, e2, e3 };
leaf::try_handle_some(
[]
{
return f(); // returns leaf::result<T>
},
[]( leaf::match<my_enum, my_enum::e1, my_enum::e2> m )
{ <i class="conum" data-value="1"></i><b>(1)</b>
static_assert(std::is_same<my_enum, decltype(m.matched)>::value);
assert(m.matched == my_enum::e1 || m.matched == my_enum::e2);
....
} );</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>The handler is selected if an object of type <code>my_enum</code>, which compares equal to <code>e1</code> or to <code>e2</code>, is associated with the detected error.</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Example 2: Handling of a subset of std::error_code enum values (requires at least C++17, see Example 4 for a C++11-compatible workaround).</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum class my_enum { e1=1, e2, e3 };
namespace std
{
template <> struct is_error_code_enum<my_enum>: std::true_type { };
}
leaf::try_handle_some(
[]
{
return f(); // returns leaf::result<T>
},
[]( leaf::match<std::error_code, my_enum::e1, my_enum::e2> m )
{ <i class="conum" data-value="1"></i><b>(1)</b>
static_assert(std::is_same<std::error_code const &, decltype(m.matched)>::value);
assert(m.matched == my_enum::e1 || m.matched == my_enum::e2);
....
} );</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>The handler is selected if an object of type <code>std::error_code</code>, which compares equal to <code>e1</code> or to <code>e2</code>, is associated with the detected error.</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Example 3: Handling of a specific std::error_code::category (requires at least C++17).</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum class enum_a { a1=1, a2, a3 };
enum class enum_b { b1=1, b2, b3 };
namespace std
{
template <> struct is_error_code_enum<enum_a>: std::true_type { };
template <> struct is_error_code_enum<enum_b>: std::true_type { };
}
leaf::try_handle_some(
[]
{
return f(); // returns leaf::result<T>
},
[]( leaf::match<std::error_code, leaf::category<enum_a>, enum_b::b2> m )
{ <i class="conum" data-value="1"></i><b>(1)</b>
static_assert(std::is_same<std::error_code const &, decltype(m.matched)>::value);
assert(&m.matched.category() == &std::error_code(enum_{}).category() || m.matched == enum_b::b2);
....
} );</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>The handler is selected if an object of type <code>std::error_code</code>, which either has the same <code>std::error_category</code> as that of <code>enum_a</code> or compares equal to <code>enum_b::b2</code>, is associated with the detected error.</td>
</tr>
</table>
</div>
<div id="condition" class="paragraph">
<p>The use of the <code>leaf::category</code> template requires automatic deduction of the type of each <code>V<sub>i</sub></code>, which in turn requires C++17 or newer. The same applies to the use of <code>std::error_code</code> as <code>E</code>, but LEAF provides a compatible C++11 workaround for this case, using the template <code>condition</code>. The following is equivalent to Example 2:</p>
</div>
<div class="listingblock">
<div class="title">Example 4: Handling of a subset of std::error_code enum values using the C++11-compatible API.</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">enum class my_enum { e1=1, e2, e3 };
namespace std
{
template <> struct is_error_code_enum<my_enum>: std::true_type { };
}
leaf::try_handle_some(
[]
{
return f(); // returns leaf::result<T>
},
[]( leaf::match<leaf::condition<my_enum>, my_enum::e1, my_enum::e2> m )
{
static_assert(std::is_same<std::error_code const &, decltype(m.matched)>::value);
assert(m.matched == my_enum::e1 || m.matched == my_enum::e2);
....
} );</code></pre>
</div>
</div>
<div class="paragraph">
<p>Instead of a set of values, the <code>match</code> template can be given pointers to functions that implement a custom comparison. In the following example, we define a handler which will be selected to handle any error that communicates an object of the user-defined type <code>severity</code> with value greater than 4:</p>
</div>
<div class="listingblock">
<div class="title">Example 5: Handling of failures with severity::value greater than a specified threshold (requires at least C++17).</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct severity { int value; }
template <int S>
constexpr bool severity_greater_than( severity const & e ) noexcept
{
return e.value > S;
}
leaf::try_handle_some(
[]
{
return f(); // returns leaf::result<T>
},
[]( leaf::match<severity, severity_greater_than<4>> m )
{
static_assert(std::is_same<severity const &, decltype(m.matched)>::value);
assert(m.matched.value > 4);
....
} );</code></pre>
</div>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="match_member"><code>match_member</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/pred.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <auto, auto... V>
struct match_member;
template <class E, class T, T E::* P, auto... V>
struct match_member<P, V...>
{
E const & matched;
// Other members not specified
};
template <auto P, auto... V>
struct is_predicate<match_member<P, V...>>: std::true_type
{
};
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#is_predicate"><code>is_predicate</code></a></p>
</div>
<div class="paragraph">
<p>This predicate is similar to <a href="#match_value"><code>match_value</code></a>, but able to bind any accessible data member of <code>E</code>; e.g. <code>match_member<&E::value, V…​></code> is equivalent to <code>match_value<E, V…​></code>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
See also <a href="#tutorial-predicates">Using Predicates to Handle Errors</a>.
</td>
</tr>
</table>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
<code>match_member</code> requires at least C++17, whereas <code>match_value</code> does not.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="match_value"><code>match_value</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/pred.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class E, auto... V>
struct match_value
{
E const & matched;
// Other members not specified
};
template <class E, auto... V>
struct is_predicate<match_value<E, V...>>: std::true_type
{
};
} }</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#is_predicate"><code>is_predicate</code></a></p>
</div>
<div class="paragraph">
<p>This predicate is similar to <a href="#match"><code>match</code></a>, but where <code>match</code> compares the available error object <code>e</code> of type <code>E</code> to the specified values <code>V…​</code>, <code>match_value</code> works with <code>e.value</code>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
See also <a href="#tutorial-predicates">Using Predicates to Handle Errors</a>.
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct e_errno { int value; }
leaf::try_handle_some(
[]
{
return f(); // returns leaf::result<T>
},
[]( leaf::match_value<e_errno, ENOENT> m )
{ <i class="conum" data-value="1"></i><b>(1)</b>
static_assert(std::is_same<e_errno const &, decltype(m.matched)>::value);
assert(m.matched.value == ENOENT);
....
} );</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>The handler is selected if an object of type <a href="#e_errno"><code>e_errno</code></a>, with <code>.value</code> equal to <code>ENOENT</code>, is associated with the detected error.</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="traits">Reference: Traits</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="is_predicate"><code>is_predicate</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/pred.hpp>></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class T>
struct is_predicate: std::false_type
{
};
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>is_predicate</code> template is used by the <a href="#handler_selection_procedure">handler selection procedure</a> to detect predicate types. See <a href="#tutorial-predicates">Using Predicates to Handle Errors</a>.</p>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="is_result_type"><code>is_result_type</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp>></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace boost { namespace leaf {
template <class R>
struct is_result_type: std::false_type
{
};
} }</code></pre>
</div>
</div>
<div class="paragraph">
<p>The error-handling functionality provided by <a href="#try_handle_some"><code>try_handle_some</code></a> and <a href="#try_handle_all"><code>try_handle_all</code></a> — including the ability to <a href="#tutorial-loading">load</a> error objects of arbitrary types — is compatible with any external <code>result<T></code> type R, as long as for a given object <code>r</code> of type <code>R</code>:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>If <code>bool(r)</code> is <code>true</code>, <code>r</code> indicates success, in which case it is valid to call <code>r.value()</code> to recover the <code>T</code> value.</p>
</li>
<li>
<p>Otherwise <code>r</code> indicates a failure, in which case it is valid to call <code>r.error()</code>. The returned value is used to initialize an <code>error_id</code> (note: <code>error_id</code> can be initialized by <code>std::error_code</code>).</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>To use an external <code>result<T></code> type R, you must specialize the <code>is_result_type</code> template so that <code>is_result_type<R>::value</code> evaluates to <code>true</code>.</p>
</div>
<div class="paragraph">
<p>Naturally, the provided <code>leaf::<a href="#result">result</a><T></code> class template satisfies these requirements. In addition, it allows error objects to be transported across thread boundaries, using a <code>std::shared_ptr<<a href="#polymorphic_context">polymorphic_context</a>></code>.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="macros">Reference: Macros</h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
The contents of each Reference section are organized alphabetically.
</td>
</tr>
</table>
</div>
<hr>
<div class="sect2">
<h3 id="BOOST_LEAF_ASSIGN"><code>BOOST_LEAF_ASSIGN</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">#define BOOST_LEAF_ASSIGN(v, r)\
auto && <<temp>> = r;\
if( !<<temp>> )\
return <<temp>>.error();\
v = std::forward<decltype(<<temp>>)>(<<temp>>).value()</code></pre>
</div>
</div>
<div class="paragraph">
<p><code>BOOST_LEAF_ASSIGN</code> is useful when calling a function that returns <code>result<T></code> (other than <code>result<void></code>), if the desired behavior is to forward any errors to the caller verbatim.</p>
</div>
<div class="paragraph">
<p>In case of success, the result <code>value()</code> of type <code>T</code> is assigned to the specified variable <code>v</code>, which must have been declared prior to invoking <code>BOOST_LEAF_ASSIGN</code>. However, it is possible to use <code>BOOST_LEAF_ASSIGN</code> to declare a new variable, by passing in <code>v</code> its type together with its name, e.g. <code>BOOST_LEAF_ASSIGN(auto && x, f())</code> calls <code>f</code>, forwards errors to the caller, while capturing successful values in <code>x</code>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
See also <a href="#BOOST_LEAF_AUTO"><code>BOOST_LEAF_AUTO</code></a>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="BOOST_LEAF_AUTO"><code>BOOST_LEAF_AUTO</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">#define BOOST_LEAF_AUTO(v, r)\
BOOST_LEAF_ASSIGN(auto v, r)</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#BOOST_LEAF_ASSIGN"><code>BOOST_LEAF_ASSIGN</code></a></p>
</div>
<div class="paragraph">
<p><code>BOOST_LEAF_AUTO</code> is useful when calling a function that returns <code>result<T></code> (other than <code>result<void></code>), if the desired behavior is to forward any errors to the caller verbatim.</p>
</div>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<int> compute_value();
leaf::result<float> add_values()
{
BOOST_LEAF_AUTO(v1, compute_value()); <i class="conum" data-value="1"></i><b>(1)</b>
BOOST_LEAF_AUTO(v2, compute_value()); <i class="conum" data-value="2"></i><b>(2)</b>
return v1 + v2;
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Call <code>compute_value</code>, bail out on failure, define a local variable <code>v1</code> on success.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Call <code>compute_value</code> again, bail out on failure, define a local variable <code>v2</code> on success.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Of course, we could write <code>add_value</code> without using <code>BOOST_LEAF_AUTO</code>. This is equivalent:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="nowrap">leaf::result<float> add_values()
{
auto v1 = compute_value();
if( !v1 )
return v1.error();
auto v2 = compute_value();
if( !v2 )
return v2.error();
return v1.value() + v2.value();
}</pre>
</div>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
See also <a href="#BOOST_LEAF_ASSIGN"><code>BOOST_LEAF_ASSIGN</code></a>.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="BOOST_LEAF_CHECK"><code>BOOST_LEAF_CHECK</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">#define BOOST_LEAF_CHECK(r)\
{\
auto && <<temp>> = r;\
if(!<<temp>>)\
return <<temp>>.error();\
}</code></pre>
</div>
</div>
<div class="paragraph">
<p><code>BOOST_LEAF_CHECK</code> is useful when calling a function that returns <code>result<void></code>, if the desired behavior is to forward any errors to the caller verbatim.</p>
</div>
<div class="listingblock">
<div class="title">Example:</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<void> send_message( char const * msg );
leaf::result<int> compute_value();
leaf::result<int> say_hello_and_compute_value()
{
BOOST_LEAF_CHECK(send_message("Hello!")); <i class="conum" data-value="1"></i><b>(1)</b>
return compute_value();
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Try to send a message, then compute a value, report errors using BOOST_LEAF_CHECK.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Equivalent implementation without <code>BOOST_LEAF_CHECK</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="nowrap">leaf::result<float> add_values()
{
auto r = send_message("Hello!");
if( !r )
return r.error();
return compute_value();
}</pre>
</div>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="BOOST_LEAF_EXCEPTION"><code>BOOST_LEAF_EXCEPTION</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/exception.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">#define BOOST_LEAF_EXCEPTION <<voodoo>></code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p><code>BOOST_LEAF_EXCEPTION(e…​)</code> is equivalent to <code>leaf::<a href="#exception">exception</a>(e…​)</code>, except the current source location is automatically passed, in a <code><a href="#e_source_location"><code>e_source_location</code></a></code> object (in addition to all <code>e…​</code> objects).</p>
</dd>
</dl>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="BOOST_LEAF_NEW_ERROR"><code>BOOST_LEAF_NEW_ERROR</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/error.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">#define BOOST_LEAF_NEW_ERROR <<voodoo>></code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p><code>BOOST_LEAF_NEW_ERROR(e…​)</code> is equivalent to <code>leaf::<a href="#new_error">new_error</a>(e…​)</code>, except the current source location is automatically passed, in a <code><a href="#e_source_location"><code>e_source_location</code></a></code> object (in addition to all <code>e…​</code> objects).</p>
</dd>
</dl>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="BOOST_LEAF_THROW_EXCEPTION"><code>BOOST_LEAF_THROW_EXCEPTION</code></h3>
<div class="listingblock">
<div class="title">#include <boost/leaf/exception.hpp></div>
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">#define BOOST_LEAF_THROW_EXCEPTION throw BOOST_LEAF_EXCEPTION</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>Throws the exception object returned by <a href="#BOOST_LEAF_EXCEPTION"><code>BOOST_LEAF_EXCEPTION</code></a>.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="rationale">Design</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_rationale">Rationale</h3>
<div class="dlist">
<dl>
<dt class="hdlist1">Definition: </dt>
<dd>
<p>Objects that carry information about error conditions are called error objects. For example, objects of type <code>std::error_code</code> are error objects.</p>
</dd>
</dl>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
The following reasoning is independent of the mechanism used to transport error objects, whether it is exception handling or anything else.
</td>
</tr>
</table>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Definition: </dt>
<dd>
<p>Depending on their interaction with error objects, functions can be classified as follows:</p>
<div class="ulist">
<ul>
<li>
<p><strong>Error-initiating</strong>: functions that initiate error conditions by creating new error objects.</p>
</li>
<li>
<p><strong>Error-neutral</strong>: functions that forward to the caller error objects communicated by lower-level functions they call.</p>
</li>
<li>
<p><strong>Error-handling</strong>: functions that dispose of error objects they have received, recovering normal program operation.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
<div class="paragraph">
<p>A crucial observation is that <em>error-initiating</em> functions are typically low-level functions that lack any context and can not determine, much less dictate, the correct program behavior in response to the errors they may initiate. Error conditions which (correctly) lead to termination in some programs may (correctly) be ignored in others; yet other programs may recover from them and resume normal operation.</p>
</div>
<div class="paragraph">
<p>The same reasoning applies to <em>error-neutral</em> functions, but in this case there is the additional issue that the errors they need to communicate, in general, are initiated by functions multiple levels removed from them in the call chain, functions which usually are — and should be treated as — implementation details. An <em>error-neutral</em> function should not be coupled with error object types communicated by <em>error-initiating</em> functions, for the same reason it should not be coupled with any other aspect of their interface.</p>
</div>
<div class="paragraph">
<p>Finally, <em>error-handling</em> functions, by definition, have the full context they need to deal with at least some, if not all, failures. In their scope it is an absolute necessity that the author knows exactly what information must be communicated by lower level functions in order to recover from each error condition. Specifically, none of this necessary information can be treated as implementation details; in this case, the coupling which is to be avoided in <em>error-neutral</em> functions is in fact desirable.</p>
</div>
<div class="paragraph">
<p>We’re now ready to define our</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Design goals: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p><strong>Error-initiating</strong> functions should be able to communicate <span class="underline">all</span> information available to them that is relevant to the failure being reported.</p>
</li>
<li>
<p><strong>Error-neutral</strong> functions should not be coupled with error types communicated by lower-level <em>error-initiating</em> functions. They should be able to augment any failure with additional relevant information available to them.</p>
</li>
<li>
<p><strong>Error-handling</strong> functions should be able to access all the information communicated by <em>error-initiating</em> or <em>error-neutral</em> functions that is needed in order to deal with failures.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
<div class="paragraph">
<p>The design goal that <em>error-neutral</em> functions are not coupled with the static type of error objects that pass through them seems to require dynamic polymorphism and therefore dynamic memory allocations (the Boost Exception library meets this design goal at the cost of dynamic memory allocation).</p>
</div>
<div class="paragraph">
<p>As it turns out, dynamic memory allocation is not necessary due to the following</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Fact: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p><strong>Error-handling</strong> functions "know" which of the information <em>error-initiating</em> and <em>error-neutral</em> functions are <span class="underline">able</span> to communicate is <span class="underline">actually needed</span> in order to deal with failures in a particular program. Ideally, no resources should be <span class="line-through">used</span> wasted storing or communicating information which is not currently needed to handle errors, <span class="underline">even if it is relevant to the failure</span>.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
<div class="paragraph">
<p>For example, if a library function is able to communicate an error code but the program does not need to know the exact error code, then that information may be ignored at the time the library function attempts to communicate it. On the other hand, if an <em>error-handling</em> function needs that information, the memory needed to store it can be reserved statically in its scope.</p>
</div>
<div class="paragraph">
<p>The LEAF functions <a href="#try_handle_some"><code>try_handle_some</code></a>, <a href="#try_handle_all"><code>try_handle_all</code></a> and <a href="#try_catch"><code>try_catch</code></a> implement this idea. Users provide error-handling lambda functions, each taking arguments of the types it needs in order to recover from a particular error condition. LEAF simply provides the space needed to store these types (in the form of a <code>std::tuple</code>, using automatic storage duration) until they are passed to a suitable handler.</p>
</div>
<div class="paragraph">
<p>At the time this space is reserved in the scope of an error-handling function, <code>thread_local</code> pointers of the required error types are set to point to the corresponding objects within it. Later on, <em>error-initiating</em> or <em>error-neutral</em> functions wanting to communicate an error object of a given type <code>E</code> use the corresponding <code>thread_local</code> pointer to detect if there is currently storage available for this type:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>If the pointer is not null, storage is available and the object is moved into the pointed storage, exactly once — regardless of how many levels of function calls must unwind before an <em>error-handling</em> function is reached.</p>
</li>
<li>
<p>If the pointer is null, storage is not available and the error object is discarded, since no error-handling function makes any use of it in this program — saving resources.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>This almost works, except we need to make sure that <em>error-handling</em> functions are protected from accessing stale error objects stored in response to previous failures, which would be a serious logic error. To this end, each occurrence of an error is assigned a unique <a href="#error_id"><code>error_id</code></a>. Each of the <code>E…​</code> objects stored in error-handling scopes is assigned an <code>error_id</code> as well, permanently associating it with a particular failure.</p>
</div>
<div class="paragraph">
<p>Thus, to handle a failure we simply match the available error objects (associated with its unique <code>error_id</code>) with the argument types required by each user-provided error-handling function. In terms of C++ exception handling, it is as if we could write something like:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">try
{
auto r = process_file();
//Success, use r:
....
}
catch(file_read_error &, e_file_name const & fn, e_errno const & err)
{
std::cerr <<
"Could not read " << fn << ", errno=" << err << std::endl;
}
catch(file_read_error &, e_errno const & err)
{
std::cerr <<
"File read error, errno=" << err << std::endl;
}
catch(file_read_error &)
{
std::cerr << "File read error!" << std::endl;
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>Of course this syntax is not valid, so LEAF uses lambda functions to express the same idea:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::try_catch(
[]
{
auto r = process_file(); //Throws in case of failure, error objects stored inside the try_catch scope
//Success, use r:
....
}
[](file_read_error &, e_file_name const & fn, e_errno const & err)
{
std::cerr <<
"Could not read " << fn << ", errno=" << err << std::endl;
},
[](file_read_error &, e_errno const & err)
{
std::cerr <<
"File read error, errno=" << err << std::endl;
},
[](file_read_error &)
{
std::cerr << "File read error!" << std::endl;
} );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#try_catch"><code>try_catch</code></a> | <a href="#e_file_name"><code>e_file_name</code></a> | <a href="#e_errno"><code>e_errno</code></a></p>
</div>
<div class="paragraph">
<p>Similar syntax works without exception handling as well. Below is the same snippet, written using <code><a href="#result">result</a><T></code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">return leaf::try_handle_some(
[]() -> leaf::result<void>
{
BOOST_LEAF_AUTO(r, process_file()); //In case of errors, error objects are stored inside the try_handle_some scope
//Success, use r:
....
return { };
}
[](leaf::match<error_enum, file_read_error>, e_file_name const & fn, e_errno const & err)
{
std::cerr <<
"Could not read " << fn << ", errno=" << err << std::endl;
},
[](leaf::match<error_enum, file_read_error>, e_errno const & err)
{
std::cerr <<
"File read error, errno=" << err << std::endl;
},
[](leaf::match<error_enum, file_read_error>)
{
std::cerr << "File read error!" << std::endl;
} );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#try_handle_some"><code>try_handle_some</code></a> | <a href="#match"><code>match</code></a> | <a href="#e_file_name"><code>e_file_name</code></a> | <a href="#e_errno"><code>e_errno</code></a></p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Please post questions and feedback on the Boost Developers Mailing List.
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="exception_specifications">Critique 1: Error Types Do Not Participate in Function Signatures</h3>
<div class="paragraph">
<p>A knee-jerk critique of the LEAF design is that it does not statically enforce that each possible error condition is recognized and handled by the program. One idea I’ve heard from multiple sources is to add <code>E…​</code> parameter pack to <code>result<T></code>, essentially turning it into <code>expected<T,E…​></code>, so we could write something along these lines:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">expected<T, E1, E2, E3> f() noexcept; <i class="conum" data-value="1"></i><b>(1)</b>
expected<T, E1, E3> g() noexcept <i class="conum" data-value="2"></i><b>(2)</b>
{
if( expected<T, E1, E2, E3> r = f() )
{
return r; //Success, return the T
}
else
{
return r.handle_error<E2>( [] ( .... ) <i class="conum" data-value="3"></i><b>(3)</b>
{
....
} );
}
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td><code>f</code> may only return error objects of type <code>E1</code>, <code>E2</code>, <code>E3</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td><code>g</code> narrows that to only <code>E1</code> and <code>E3</code>.</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>Because <code>g</code> may only return error objects of type <code>E1</code> and <code>E3</code>, it uses <code>handle_error</code> to deal with <code>E2</code>. In case <code>r</code> contains <code>E1</code> or <code>E3</code>, <code>handle_error</code> simply returns <code>r</code>, narrowing the error type parameter pack from <code>E1, E2, E3</code> down to <code>E1, E3</code>. If <code>r</code> contains an <code>E2</code>, <code>handle_error</code> calls the supplied lambda, which is required to return one of <code>E1</code>, <code>E3</code> (or a valid <code>T</code>).</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The motivation here is to help avoid bugs in functions that handle errors that pop out of <code>g</code>: as long as the programmer deals with <code>E1</code> and <code>E3</code>, he can rest assured that no error is left unhandled.</p>
</div>
<div class="paragraph">
<p>Congratulations, we’ve just discovered exception specifications. The difference is that exception specifications, before being removed from C++, were enforced dynamically, while this idea is equivalent to statically-enforced exception specifications, like they are in Java.</p>
</div>
<div class="paragraph">
<p>Why not use the equivalent of exception specifications, even if they are enforced statically?</p>
</div>
<div class="quoteblock">
<blockquote>
The short answer is that nobody knows how to fix exception specifications in any language, because the dynamic enforcement C++ chose has only different (not greater or fewer) problems than the static enforcement Java chose. …​ When you go down the Java path, people love exception specifications until they find themselves all too often encouraged, or even forced, to add <code>throws Exception</code>, which immediately renders the exception specification entirely meaningless. (Example: Imagine writing a Java generic that manipulates an arbitrary type <code>T</code>).<sup class="footnote">[<a id="_footnoteref_1" class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup>
</blockquote>
<div class="attribution">
— Herb Sutter
</div>
</div>
<div class="paragraph">
<p>Consider again the example above: assuming we don’t want important error-related information to be lost, values of type <code>E1</code> and/or <code>E3</code> must be able to encode any <code>E2</code> value dynamically. But like Sutter points out, in generic contexts we don’t know what errors may result in calling a user-supplied function. The only way around that is to specify a single type (e.g. <code>std::error_code</code>) that can communicate any and all errors, which ultimately defeats the idea of using static type checking to enforce correct error handling.</p>
</div>
<div class="paragraph">
<p>That said, in every program there are certain <em>error-handling</em> functions (e.g. <code>main</code>) which are required to handle any error, and it is highly desirable to be able to enforce this requirement at compile-time. In LEAF, the <code>try_handle_all</code> function implements this idea: if the user fails to supply at least one handler that will match any error, the result is a compile error. This guarantees that the scope invoking <code>try_handle_all</code> is prepared to recover from any failure.</p>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="translation">Critique 2: LEAF Does Not Facilitate Mapping Between Different Error Types</h3>
<div class="paragraph">
<p>Most C++ programs use multiple C and C++ libraries, and each library may provide its own system of error codes. But because it is difficult to define static interfaces that can communicate arbitrary error code types, a popular idea is to map each library-specific error code to a common program-wide enum.</p>
</div>
<div class="paragraph">
<p>For example, if we have — </p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace lib_a
{
enum error
{
ok,
ec1,
ec2,
....
};
}</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace lib_b
{
enum error
{
ok,
ec1,
ec2,
....
};
}</code></pre>
</div>
</div>
<div class="paragraph">
<p> — we could define:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">namespace program
{
enum error
{
ok,
lib_a_ec1,
lib_a_ec2,
....
lib_b_ec1,
lib_b_ec2,
....
};
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>An error-handling library could provide conversion API that uses the C++ static type system to automate the mapping between the different error enums. For example, it may define a class template <code>result<T,E></code> with value-or-error variant semantics, so that:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>lib_a</code> errors are transported in <code>result<T,lib_a::error></code>,</p>
</li>
<li>
<p><code>lib_b</code> errors are transported in <code>result<T,lib_b::error></code>,</p>
</li>
<li>
<p>then both are automatically mapped to <code>result<T,program::error></code> once control reaches the appropriate scope.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>There are several problems with this idea:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>It is prone to errors, both during the initial implementation as well as under maintenance.</p>
</li>
<li>
<p>It does not compose well. For example, if both of <code>lib_a</code> and <code>lib_b</code> use <code>lib_c</code>, errors that originate in <code>lib_c</code> would be obfuscated by the different APIs exposed by each of <code>lib_a</code> and <code>lib_b</code>.</p>
</li>
<li>
<p>It presumes that all errors in the program can be specified by exactly one error code, which is false.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>To elaborate on the last point, consider a program that attempts to read a configuration file from three different locations: in case all of the attempts fail, it should communicate each of the failures. In theory <code>result<T,E></code> handles this case well:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct attempted_location
{
std::string path;
error ec;
};
struct config_error
{
attempted_location current_dir, user_dir, app_dir;
};
result<config,config_error> read_config();</code></pre>
</div>
</div>
<div class="paragraph">
<p>This looks nice, until we realize what the <code>config_error</code> type means for the automatic mapping API we wanted to define: an <code>enum</code> can not represent a <code>struct</code>. It is a fact that we can not assume that all error conditions can be fully specified by an <code>enum</code>; an error handling library must be able to transport arbitrary static types efficiently.</p>
</div>
</div>
<div class="sect2">
<h3 id="errors_are_not_implementation_details">Critique 3: LEAF Does Not Treat Low Level Error Types as Implementation Details</h3>
<div class="paragraph">
<p>This critique is a combination of <a href="#exception_specifications">Critique 1</a> and <a href="#translation">Critique 2</a>, but it deserves special attention. Let’s consider this example using LEAF:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::result<std::string> read_line( reader & r );
leaf::result<parsed_line> parse_line( std::string const & line );
leaf::result<parsed_line> read_and_parse_line( reader & r )
{
BOOST_LEAF_AUTO(line, read_line(r)); <i class="conum" data-value="1"></i><b>(1)</b>
BOOST_LEAF_AUTO(parsed, parse_line(line)); <i class="conum" data-value="2"></i><b>(2)</b>
return parsed;
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#result"><code>result</code></a> | <a href="#BOOST_LEAF_AUTO"><code>BOOST_LEAF_AUTO</code></a></p>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Read a line, forward errors to the caller.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Parse the line, forward errors to the caller.</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The objection is that LEAF will forward verbatim the errors that are detected in <code>read_line</code> or <code>parse_line</code> to the caller of <code>read_and_parse_line</code>. The premise of this objection is that such low-level errors are implementation details and should be treated as such. Under this premise, <code>read_and_parse_line</code> should act as a translator of sorts, in both directions:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>When called, it should translate its own arguments to call <code>read_line</code> and <code>parse_line</code>;</p>
</li>
<li>
<p>If an error is detected, it should translate the errors from the error types returned by <code>read_line</code> and <code>parse_line</code> to a higher-level type.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>The motivation is to isolate the caller of <code>read_and_parse_line</code> from its implementation details <code>read_line</code> and <code>parse_line</code>.</p>
</div>
<div class="paragraph">
<p>There are two possible ways to implement this translation:</p>
</div>
<div class="paragraph">
<p><strong>1)</strong> <code>read_and_parse_line</code> understands the semantics of <strong>all possible failures</strong> that may be reported by both <code>read_line</code> and <code>parse_line</code>, implementing a non-trivial mapping which both <em>erases</em> information that is considered not relevant to its caller, as well as encodes <em>different</em> semantics in the error it reports. In this case <code>read_and_parse_line</code> assumes full responsibility for describing precisely what went wrong, using its own type specifically designed for the job.</p>
</div>
<div class="paragraph">
<p><strong>2)</strong> <code>read_and_parse_line</code> returns an error object that essentially indicates which of the two inner functions failed, and also transports the original error object without understanding its semantics and without any loss of information, wrapping it in a new error type.</p>
</div>
<div class="paragraph">
<p>The problem with <strong>1)</strong> is that typically the caller of <code>read_and_parse_line</code> is not going to handle the error, but it does need to forward it to its caller. In our attempt to protect the <strong>one</strong> error-handling function from "implementation details", we’ve coupled the interface of <strong>all</strong> intermediate error-neutral functions with the static types of errors they do not understand and do not handle.</p>
</div>
<div class="paragraph">
<p>Consider the case where <code>read_line</code> communicates <code>errno</code> in its errors. What is <code>read_and_parse_line</code> supposed to do with e.g. <code>EACCESS</code>? Turn it into <code>READ_AND_PARSE_LINE_EACCESS</code>? To what end, other than to obfuscate the original (already complex and platform-specific) semantics of <code>errno</code>?</p>
</div>
<div class="paragraph">
<p>And what if the call to <code>read</code> is polymorphic, which is also typical? What if it involves a user-supplied function object? What kinds of errors does it return and why should <code>read_and_parse_line</code> care?</p>
</div>
<div class="paragraph">
<p>Therefore, we’re left with <strong>2)</strong>. There’s almost nothing wrong with this option, since it passes any and all error-related information from lower level functions without any loss. However, using a wrapper type to grant (presumably dynamic) access to any lower-level error type it may be transporting is cumbersome and (like Niall Douglas <a href="#interoperability">explains</a>) in general probably requires dynamic allocations. It is better to use independent error types that communicate the additional information not available in the original error object, while error handlers rely on LEAF to provide efficient access to any and all low-level error types, as needed.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_alternatives_to_leaf">Alternatives to LEAF</h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="https://www.boost.org/doc/libs/release/libs/exception/doc/boost-exception.html">Boost Exception</a></p>
</li>
<li>
<p><a href="https://ned14.github.io/outcome">Boost Outcome</a></p>
</li>
<li>
<p><a href="https://github.com/TartanLlama/expected"><code>tl::expected</code></a></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Below we offer a comparison of Boost LEAF to Boost Exception and to Boost Outcome.</p>
</div>
<div class="sect2">
<h3 id="boost_exception">Comparison to Boost Exception</h3>
<div class="paragraph">
<p>While LEAF can be used without exception handling, in the use case when errors are communicated by throwing exceptions, it can be viewed as a better, more efficient alternative to Boost Exception. LEAF has the following advantages over Boost Exception:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>LEAF does not allocate memory dynamically;</p>
</li>
<li>
<p>LEAF does not waste system resources communicating error objects not used by specific error handling functions;</p>
</li>
<li>
<p>LEAF does not store the error objects in the exception object, and therefore it is able to augment exceptions thrown by external libraries (Boost Exception can only augment exceptions of types that derive from <code>boost::exception</code>).</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>The following tables outline the differences between the two libraries which should be considered when code that uses Boost Exception is refactored to use LEAF instead.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
It is possible to access Boost Exception error information using the LEAF error handling interface. See <a href="#tutorial-boost_exception_integration">Boost Exception Integration</a>.
</td>
</tr>
</table>
</div>
<table class="tableblock frame-all grid-all stripes-none stretch">
<caption class="title">Table 1. Defining a custom type for transporting values of type T</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Boost Exception</th>
<th class="tableblock halign-left valign-top">LEAF</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">typedef error_info<struct my_info_,T> my_info;</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="https://www.boost.org/doc/libs/release/libs/exception/doc/error_info.html"><code>boost::error_info</code></a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">struct my_info { T value; };</code></pre>
</div>
</div></div></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-none stretch">
<caption class="title">Table 2. Passing arbitrary info at the point of the throw</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Boost Exception</th>
<th class="tableblock halign-left valign-top">LEAF</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">throw my_exception() <<
my_info(x) <<
my_info(y);</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="https://www.boost.org/doc/libs/release/libs/exception/doc/exception_operator_shl.html"><code>operator<<</code></a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">throw leaf::exception( my_exception(),
my_info{x},
my_info{y} );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#exception"><code>exception</code></a></p>
</div></div></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-none stretch">
<caption class="title">Table 3. Augmenting exceptions in error-neutral contexts</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Boost Exception</th>
<th class="tableblock halign-left valign-top">LEAF</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">try
{
f();
}
catch( boost::exception & e )
{
e << my_info(x);
throw;
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="https://www.boost.org/doc/libs/release/libs/exception/doc/exception.html"><code>boost::exception</code></a> | <a href="https://www.boost.org/doc/libs/release/libs/exception/doc/exception_operator_shl.html"><code>operator<<</code></a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">auto load = leaf::on_error( my_info{x} );
f();</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#on_error"><code>on_error</code></a></p>
</div></div></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-none stretch">
<caption class="title">Table 4. Obtaining arbitrary info at the point of the catch</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Boost Exception</th>
<th class="tableblock halign-left valign-top">LEAF</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">try
{
f();
}
catch( my_exception & e )
{
if( T * v = get_error_info<my_info>(e) )
{
//my_info is available in e.
}
}</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="https://www.boost.org/doc/libs/release/libs/exception/doc/get_error_info.html"><code>boost::get_error_info</code></a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-c++" data-lang="c++">leaf::try_catch(
[]
{
f(); // throws
}
[](my_exception &, my_info const & x)
{
//my_info is available with
//the caught exception.
} );</code></pre>
</div>
</div>
<div class="paragraph text-right">
<p><a href="#try_catch"><code>try_catch</code></a></p>
</div></div></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-none stretch">
<caption class="title">Table 5. Transporting of error objects</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Boost Exception</th>
<th class="tableblock halign-left valign-top">LEAF</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>All supplied <a href="https://www.boost.org/doc/libs/release/libs/exception/doc/error_info.html"><code>boost::error_info</code></a> objects are allocated dynamically and stored in the <a href="https://www.boost.org/doc/libs/release/libs/exception/doc/exception.html"><code>boost::exception</code></a> subobject of exception objects.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>User-defined error objects are stored statically in the scope of <a href="#try_catch"><code>try_catch</code></a>, but only if their types are needed to handle errors; otherwise they are discarded.</p>
</div></div></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-none stretch">
<caption class="title">Table 6. Transporting of error objects across thread boundaries</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Boost Exception</th>
<th class="tableblock halign-left valign-top">LEAF</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="https://www.boost.org/doc/libs/release/libs/exception/doc/exception_ptr.html"><code>boost::exception_ptr</code></a> automatically captures <a href="https://www.boost.org/doc/libs/release/libs/exception/doc/error_info.html"><code>boost::error_info</code></a> objects stored in a <code>boost::exception</code> and can transport them across thread boundaries.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Transporting error objects across thread boundaries requires the use of <a href="#capture"><code>capture</code></a>.</p>
</div></div></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-none stretch">
<caption class="title">Table 7. Printing of error objects in automatically-generated diagnostic information messages</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Boost Exception</th>
<th class="tableblock halign-left valign-top">LEAF</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>boost::error_info</code> types may define conversion to <code>std::string</code> by providing <code>to_string</code> overloads <strong>or</strong> by overloading <code>operator<<</code> for <code>std::ostream</code>.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>LEAF does not use <code>to_string</code>. Error types may define <code>operator<<</code> overloads for <code>std::ostream</code>.</p>
</div></div></td>
</tr>
</tbody>
</table>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The fact that Boost Exception stores all supplied <code>boost::error_info</code> objects — while LEAF discards them if they aren’t needed — affects the completeness of the message we get when we print <code>leaf::<a href="#diagnostic_info">diagnostic_info</a></code> objects, compared to the string returned by <a href="https://www.boost.org/doc/libs/release/libs/exception/doc/diagnostic_information.html"><code>boost::diagnostic_information</code></a>.</p>
</div>
<div class="paragraph">
<p>If the user requires a complete diagnostic message, the solution is to use <code>leaf::<a href="#verbose_diagnostic_info">verbose_diagnostic_info</a></code>. In this case, before unused error objects are discarded by LEAF, they are converted to string and printed. Note that this allocates memory dynamically.</p>
</div>
</td>
</tr>
</table>
</div>
<hr>
</div>
<div class="sect2">
<h3 id="boost_outcome">Comparison to Boost Outcome</h3>
<div class="sect3">
<h4 id="_design_differences">Design Differences</h4>
<div class="paragraph">
<p>Like LEAF, the <a href="https://ned14.github.io/outcome">Boost Outcome</a> library is designed to work in low latency environments. It provides two class templates, <code>result<></code> and <code>outcome<></code>:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>result<T,EC,NVP></code> can be used as the return type in <code>noexcept</code> functions which may fail, where <code>T</code> specifies the type of the return value in case of success, while <code>EC</code> is an "error code" type. Semantically, <code>result<T,EC></code> is similar to <code>std::variant<T,EC></code>. Naturally, <code>EC</code> defaults to <code>std::error_code</code>.</p>
</li>
<li>
<p><code>outcome<T,EC,EP,NVP></code> is similar to <code>result<></code>, but in case of failure, in addition to the "error code" type <code>EC</code> it can hold a "pointer" object of type <code>EP</code>, which defaults to <code>std::exception_ptr</code>.</p>
</li>
</ul>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<code>NVP</code> is a policy type used to customize the behavior of <code>.value()</code> when the <code>result<></code> or the <code>outcome<></code> object contains an error.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The idea is to use <code>result<></code> to communicate failures which can be fully specified by an "error code", and <code>outcome<></code> to communicate failures that require additional information.</p>
</div>
<div class="paragraph">
<p>Another way to describe this design is that <code>result<></code> is used when it suffices to return an error object of some static type <code>EC</code>, while <code>outcome<></code> can also transport a polymorphic error object, using the pointer type <code>EP</code>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
In the default configuration of <code>outcome<T></code> the additional information — or the additional polymorphic object — is an exception object held by <code>std::exception_ptr</code>. This targets the use case when an exception thrown by a lower-level library function needs to be transported through some intermediate contexts that are not exception-safe, to a higher-level context able to handle it. LEAF directly supports this use as well, see <a href="#exception_to_result"><code>exception_to_result</code></a>.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Similar reasoning drives the design of LEAF as well. The difference is that while both libraries recognize the need to transport "something else" in addition to an "error code", LEAF provides an efficient solution to this problem, while Outcome shifts this burden to the user.</p>
</div>
<div class="paragraph">
<p>The <code>leaf::result<></code> template deletes both <code>EC</code> and <code>EP</code>, which decouples it from the type of the error objects that are transported in case of a failure. This enables lower-level functions to freely communicate anything and everything they "know" about the failure: error code, even multiple error codes, file names, URLs, port numbers, etc. At the same time, the higher-level error-handling functions control which of this information is needed in a specific client program and which is not. This is ideal, because:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Authors of lower-level library functions lack context to determine which of the information that is both relevant to the error <em>and</em> naturally available to them needs to be communicated in order for a particular client program to recover from that error;</p>
</li>
<li>
<p>Authors of higher-level error-handling functions can easily and confidently make this determination, which they communicate naturally to LEAF, by simply writing the different error handlers. LEAF will transport the needed error objects while discarding the ones handlers don’t care to use, saving resources.</p>
</li>
</ul>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
The LEAF examples include an adaptation of the program from the <a href="https://ned14.github.io/outcome/tutorial/essential/result/">Boost Outcome <code>result<></code> tutorial</a>. You can <a href="https://github.com/boostorg/leaf/blob/master/examples/print_half.cpp?ts=4">view it on GitHub</a>.
</td>
</tr>
</table>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Programs using LEAF for error-handling are not required to use <code>leaf::result<T></code>; for example, it is possible to use <code>outcome::result<T></code> with LEAF.
</td>
</tr>
</table>
</div>
</div>
<div class="sect3">
<h4 id="interoperability">The Interoperability Problem</h4>
<div class="paragraph">
<p>The Boost Outcome documentation discusses the important problem of bringing together multiple libraries — each using its own error reporting mechanism — and incorporating them in a robust error handling infrastructure in a client program.</p>
</div>
<div class="paragraph">
<p>Users are advised that whenever possible they should use a common error handling system throughout their entire codebase, but because this is not practical, both the <code>result<></code> and the <code>outcome<></code> templates can carry user-defined "payloads".</p>
</div>
<div class="paragraph">
<p>The following analysis is from the Boost Outcome documentation:</p>
</div>
<div class="exampleblock">
<div class="content">
<div class="paragraph">
<p>If library A uses <code>result<T, libraryA::failure_info></code>, and library B uses <code>result<T, libraryB::error_info></code> and so on, there becomes a problem for the application writer who is bringing in these third party dependencies and tying them together into an application. As a general rule, each third party library author will not have built in explicit interoperation support for unknown other third party libraries. The problem therefore lands with the application writer.</p>
</div>
<div class="paragraph">
<p>The application writer has one of three choices:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>In the application, the form of result used is <code>result<T, std::variant<E1, E2, …​>></code> where <code>E1, E2 …</code> are the failure types for every third party library in use in the application. This has the advantage of preserving the original information exactly, but comes with a certain amount of use inconvenience and maybe excessive coupling between high level layers and implementation detail.</p>
</li>
<li>
<p>One can translate/map the third party’s failure type into the application’s failure type at the point of the failure exiting the third party library and entering the application. One might do this, say, with a C preprocessor macro wrapping every invocation of the third party API from the application. This approach may lose the original failure detail, or mis-map under certain circumstances if the mapping between the two systems is not one-one.</p>
</li>
<li>
<p>One can type erase the third party’s failure type into some application failure type, which can later be reconstituted if necessary. <strong>This is the cleanest solution with the least coupling issues and no problems with mis-mapping</strong>, but it almost certainly requires the use of <code>malloc</code> which the previous two did not.</p>
</li>
</ol>
</div>
</div>
</div>
<div class="paragraph">
<p>The analysis above (emphasis added) is clear and precise, but LEAF and Boost Outcome tackle the interoperability problem differently:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>The Boost Outcome design asserts that the "cleanest" solution based on type-erasure is suboptimal ("almost certainly requires the use of <code>malloc</code>"), and instead provides a system for injecting custom converters into the <code>outcome::convert</code> namespace, used to translate between library-specific and program-wide error types, even though this approach "may lose the original failure detail".</p>
</li>
<li>
<p>The LEAF design asserts that coupling the signatures of <a href="#rationale">error-neutral</a> functions with the static types of the error objects they need to forward to the caller <a href="#translation">does not scale</a>, and instead transports error objects directly to error-handling scopes where they are stored statically, effectively implementing the third choice outlined above (without the use of <code>malloc</code>).</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Further, consider that Outcome aims to hopefully become <em>the</em> one error-handling API all libraries would use, and in theory everyone would benefit from uniformity and standardization. But the reality is that this is wishful thinking. In fact, that reality is reflected in the design of <code>outcome::result<></code>, in its lack of commitment to using <code>std::error_code</code> for its intended purpose: to be <em>the</em> standard type for transporting error codes. The fact is that <code>std::error_code</code> became <em>yet another</em> error code type programmers need to understand and support.</p>
</div>
<div class="paragraph">
<p>In contrast, the design of LEAF acknowledges that C++ programmers don’t even agree on what a string is. If your project uses 10 different libraries, this probably means 15 different ways to report errors, sometimes across uncooperative interfaces (e.g. C APIs). LEAF helps you get the job done.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_benchmark">Benchmark</h2>
<div class="sectionbody">
<div class="paragraph">
<p><a href="https://github.com/boostorg/leaf/blob/master/benchmark/benchmark.md">This benchmark</a> compares the performance of LEAF, Boost Outcome and <code>tl::expected</code>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_running_the_unit_tests">Running the Unit Tests</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The unit tests can be run with <a href="https://mesonbuild.com">Meson Build</a> or with Boost Build. To run the unit tests:</p>
</div>
<div class="sect2">
<h3 id="_meson_build">Meson Build</h3>
<div class="paragraph">
<p>Clone LEAF into any local directory and execute:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-sh" data-lang="sh">cd leaf
meson bld/debug
cd bld/debug
meson test</code></pre>
</div>
</div>
<div class="paragraph">
<p>See <code>meson_options.txt</code> found in the root directory for available build options.</p>
</div>
</div>
<div class="sect2">
<h3 id="_boost_build">Boost Build</h3>
<div class="paragraph">
<p>Assuming the current working directory is <code><boostroot>/libs/leaf</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-sh" data-lang="sh">../../b2 test</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_configuration_macros">Configuration Macros</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following configuration macros are recognized:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>BOOST_LEAF_DIAGNOSTICS</code>: Defining this macro to <code>0</code> stubs out both <a href="#diagnostic_info"><code>diagnostic_info</code></a> and <a href="#verbose_diagnostic_info"><code>verbose_diagnostic_info</code></a>, which could improve the performance of the error path in some programs (if the macro is left undefined, LEAF defines it as <code>1</code>).</p>
</li>
<li>
<p><code>BOOST_LEAF_NO_EXCEPTIONS</code>: Disables all exception handling support. If left undefined, LEAF defines it based on the compiler configuration (e.g. <code>-fno-exceptions</code>).</p>
</li>
<li>
<p><code>BOOST_LEAF_NO_THREADS</code>: Disable all multi-thread support.</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_acknowledgements">Acknowledgements</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Special thanks to Peter Dimov and Sorin Fetche.</p>
</div>
<div class="paragraph">
<p>Ivo Belchev, Sean Palmer, Jason King, Vinnie Falco, Glen Fernandes, Nir Friedman, Augustín Bergé — thanks for the valuable feedback.</p>
</div>
<div class="paragraph">
<p>Documentation rendered by <a href="https://asciidoctor.org/">Asciidoctor</a> with <a href="https://github.com/zajo/asciidoctor_skin">these customizations</a>.</p>
</div>
</div>
</div>
</div>
<div id="footnotes">
<hr>
<div class="footnote" id="_footnotedef_1">
<a href="#_footnoteref_1">1</a>. <a href="https://herbsutter.com/2007/01/24/questions-about-exception-specifications/" class="bare">https://herbsutter.com/2007/01/24/questions-about-exception-specifications/</a>
</div>
</div>
<div id="footer">
<div id="footer-text">
</div>
</div>
</body>
</html> |
<!--
If you want to include any custom html just before </body>, put it in /layouts/partials/extended_footer.html
Do not put anything in this file - it's only here so that hugo won't throw an error if /layouts/partials/extended_footer.html doesn't exist.
--> |
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Ресурс отсутствует</title>
<link rel="stylesheet" type="text/css" href="/style.css" />
</head>
<body>
<h1>Ресурс отсутствует</h1>
<h3>Какая досада</h3>
</body>
</html> |
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Overlay | RAML JS Parser 2</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script src="../assets/js/modernizr.js"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">RAML JS Parser 2</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_src_raml1_artifacts_raml10parserapi_.html">"src/raml1/artifacts/raml10parserapi"</a>
</li>
<li>
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html">Overlay</a>
</li>
</ul>
<h1>Interface Overlay</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="_src_raml1_artifacts_raml10parserapi_.api.html" class="tsd-signature-type">Api</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">Overlay</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-external">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#ramlversion" class="tsd-kind-icon">RAMLVersion</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#allbaseuriparameters" class="tsd-kind-icon">all<wbr>Base<wbr>Uri<wbr>Parameters</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#allprotocols" class="tsd-kind-icon">all<wbr>Protocols</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#allresourcetypes" class="tsd-kind-icon">all<wbr>Resource<wbr>Types</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#allresources" class="tsd-kind-icon">all<wbr>Resources</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#alltraits" class="tsd-kind-icon">all<wbr>Traits</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#annotationtypes" class="tsd-kind-icon">annotation<wbr>Types</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#annotations" class="tsd-kind-icon">annotations</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#baseuri" class="tsd-kind-icon">base<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#baseuriparameters" class="tsd-kind-icon">base<wbr>Uri<wbr>Parameters</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#childresource" class="tsd-kind-icon">child<wbr>Resource</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#definition" class="tsd-kind-icon">definition</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#description" class="tsd-kind-icon">description</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#documentation" class="tsd-kind-icon">documentation</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#errors" class="tsd-kind-icon">errors</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#expand" class="tsd-kind-icon">expand</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#extends" class="tsd-kind-icon">extends</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#kind" class="tsd-kind-icon">kind</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#mediatype" class="tsd-kind-icon">media<wbr>Type</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#meta" class="tsd-kind-icon">meta</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#optional" class="tsd-kind-icon">optional</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#optionalproperties" class="tsd-kind-icon">optional<wbr>Properties</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#parent" class="tsd-kind-icon">parent</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#protocols" class="tsd-kind-icon">protocols</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#resourcetypes" class="tsd-kind-icon">resource<wbr>Types</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#resources" class="tsd-kind-icon">resources</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#runtimedefinition" class="tsd-kind-icon">runtime<wbr>Definition</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#scalarsannotations" class="tsd-kind-icon">scalars<wbr>Annotations</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#schemas" class="tsd-kind-icon">schemas</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#securedby" class="tsd-kind-icon">secured<wbr>By</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#securityschemes" class="tsd-kind-icon">security<wbr>Schemes</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#title" class="tsd-kind-icon">title</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#tojson" class="tsd-kind-icon">toJSON</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#traits" class="tsd-kind-icon">traits</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#types" class="tsd-kind-icon">types</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#usage" class="tsd-kind-icon">usage</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#uses" class="tsd-kind-icon">uses</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#version" class="tsd-kind-icon">version</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited tsd-is-external">
<a name="ramlversion" class="tsd-anchor"></a>
<h3>RAMLVersion</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">RAMLVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#ramlversion">RAMLVersion</a></p>
<p>Overwrites <a href="_src_raml1_highlevelast_.abstractwrappernode.html">AbstractWrapperNode</a>.<a href="_src_raml1_highlevelast_.abstractwrappernode.html#ramlversion">RAMLVersion</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2065">src/raml1/artifacts/raml10parserapi.ts:2065</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns RAML version. "RAML10" string is returned for RAML 1.0. "RAML08" string is returned for RAML 0.8.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="allbaseuriparameters" class="tsd-anchor"></a>
<h3>all<wbr>Base<wbr>Uri<wbr>Parameters</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">all<wbr>Base<wbr>Uri<wbr>Parameters<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.typedeclaration.html" class="tsd-signature-type">TypeDeclaration</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#allbaseuriparameters">allBaseUriParameters</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2115">src/raml1/artifacts/raml10parserapi.ts:2115</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve an ordered list of all base uri parameters regardless of whether they are described in <code>baseUriParameters</code> or not
Consider a fragment of RAML specification:</p>
<pre><code class="lang-yaml">version: v1
baseUri: https://{organization}.example.com/{version}/{service}
baseUriParameters:
service:
</code></pre>
<p>Here <code>version</code> and <code>organization</code> are base uri parameters which are not described in the <code>baseUriParameters</code> node,
but they are among <code>Api.allBaseUriParameters()</code>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.typedeclaration.html" class="tsd-signature-type">TypeDeclaration</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="allprotocols" class="tsd-anchor"></a>
<h3>all<wbr>Protocols</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">all<wbr>Protocols<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#allprotocols">allProtocols</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2123">src/raml1/artifacts/raml10parserapi.ts:2123</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Protocols used by the API. Returns the <code>protocols</code> property value if it is specified.
Otherwise, returns protocol, specified in the base URI.</p>
</div>
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="allresourcetypes" class="tsd-anchor"></a>
<h3>all<wbr>Resource<wbr>Types</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">all<wbr>Resource<wbr>Types<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.resourcetype.html" class="tsd-signature-type">ResourceType</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html">LibraryBase</a>.<a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html#allresourcetypes">allResourceTypes</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L1965">src/raml1/artifacts/raml10parserapi.ts:1965</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve all resource types including those defined in libraries</p>
</div>
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.resourcetype.html" class="tsd-signature-type">ResourceType</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="allresources" class="tsd-anchor"></a>
<h3>all<wbr>Resources</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">all<wbr>Resources<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.resource.html" class="tsd-signature-type">Resource</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#allresources">allResources</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2084">src/raml1/artifacts/raml10parserapi.ts:2084</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve all resources of the Api</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.resource.html" class="tsd-signature-type">Resource</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="alltraits" class="tsd-anchor"></a>
<h3>all<wbr>Traits</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">all<wbr>Traits<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.trait.html" class="tsd-signature-type">Trait</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html">LibraryBase</a>.<a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html#alltraits">allTraits</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L1952">src/raml1/artifacts/raml10parserapi.ts:1952</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve all traits including those defined in libraries</p>
</div>
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.trait.html" class="tsd-signature-type">Trait</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="annotationtypes" class="tsd-anchor"></a>
<h3>annotation<wbr>Types</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">annotation<wbr>Types<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.typedeclaration.html" class="tsd-signature-type">TypeDeclaration</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html">LibraryBase</a>.<a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html#annotationtypes">annotationTypes</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L1933">src/raml1/artifacts/raml10parserapi.ts:1933</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Declarations of annotation types for use by annotations</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.typedeclaration.html" class="tsd-signature-type">TypeDeclaration</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited tsd-is-external">
<a name="annotations" class="tsd-anchor"></a>
<h3>annotations</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">annotations<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.annotationref.html" class="tsd-signature-type">AnnotationRef</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#annotations">annotations</a></p>
<p>Overwrites <a href="_src_raml1_artifacts_raml10parserapi_.annotable.html">Annotable</a>.<a href="_src_raml1_artifacts_raml10parserapi_.annotable.html#annotations">annotations</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2059">src/raml1/artifacts/raml10parserapi.ts:2059</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Most of RAML model elements may have attached annotations decribing additional meta data about this element</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.annotationref.html" class="tsd-signature-type">AnnotationRef</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="baseuri" class="tsd-anchor"></a>
<h3>base<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">base<wbr>Uri<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.fulluritemplatestring.html" class="tsd-signature-type">FullUriTemplateString</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#baseuri">baseUri</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2023">src/raml1/artifacts/raml10parserapi.ts:2023</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A URI that's to be used as the base of all the resources' URIs. Often used as the base of the URL of each resource, containing the location of the API. Can be a template URI.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.fulluritemplatestring.html" class="tsd-signature-type">FullUriTemplateString</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="baseuriparameters" class="tsd-anchor"></a>
<h3>base<wbr>Uri<wbr>Parameters</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">base<wbr>Uri<wbr>Parameters<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.typedeclaration.html" class="tsd-signature-type">TypeDeclaration</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#baseuriparameters">baseUriParameters</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2099">src/raml1/artifacts/raml10parserapi.ts:2099</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve an ordered list of all base uri parameters regardless of whether they are described in <code>baseUriParameters</code> or not
Consider a fragment of RAML specification:</p>
<pre><code class="lang-yaml">version: v1
baseUri: https://{organization}.example.com/{version}/{service}
baseUriParameters:
service:
</code></pre>
<p>Here <code>version</code> and <code>organization</code> are base uri parameters which are not described in the <code>baseUriParameters</code> node,
but they are among <code>Api.baseUriParameters()</code>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.typedeclaration.html" class="tsd-signature-type">TypeDeclaration</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="childresource" class="tsd-anchor"></a>
<h3>child<wbr>Resource</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">child<wbr>Resource<span class="tsd-signature-symbol">(</span>relPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.resource.html" class="tsd-signature-type">Resource</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#childresource">childResource</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2078">src/raml1/artifacts/raml10parserapi.ts:2078</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get child resource by its relative path</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>relPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.resource.html" class="tsd-signature-type">Resource</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="definition" class="tsd-anchor"></a>
<h3>definition</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">definition<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_node_modules_raml_definition_system_node_modules_raml_typesystem_dist_src_nominal_interfaces_d_.itypedefinition.html" class="tsd-signature-type">ITypeDefinition</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_highlevelast_.basicnode.html">BasicNode</a>.<a href="_src_raml1_highlevelast_.basicnode.html#definition">definition</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/highLevelAST.ts#L67">src/raml1/highLevelAST.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <a href="_node_modules_raml_definition_system_node_modules_raml_typesystem_dist_src_nominal_interfaces_d_.itypedefinition.html" class="tsd-signature-type">ITypeDefinition</a></h4>
<p>object representing class of the node</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="description" class="tsd-anchor"></a>
<h3>description</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.markdownstring.html" class="tsd-signature-type">MarkdownString</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#description">description</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2011">src/raml1/artifacts/raml10parserapi.ts:2011</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A longer, human-friendly description of the API</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.markdownstring.html" class="tsd-signature-type">MarkdownString</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="documentation" class="tsd-anchor"></a>
<h3>documentation</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">documentation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.documentationitem.html" class="tsd-signature-type">DocumentationItem</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#documentation">documentation</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2053">src/raml1/artifacts/raml10parserapi.ts:2053</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Additional overall documentation for the API</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.documentationitem.html" class="tsd-signature-type">DocumentationItem</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="errors" class="tsd-anchor"></a>
<h3>errors</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">errors<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_highlevelast_.ramlparsererror.html" class="tsd-signature-type">RamlParserError</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_highlevelast_.basicnode.html">BasicNode</a>.<a href="_src_raml1_highlevelast_.basicnode.html#errors">errors</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/highLevelAST.ts#L62">src/raml1/highLevelAST.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_highlevelast_.ramlparsererror.html" class="tsd-signature-type">RamlParserError</a><span class="tsd-signature-symbol">[]</span></h4>
<p>Array of errors</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="expand" class="tsd-anchor"></a>
<h3>expand</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">expand<span class="tsd-signature-symbol">(</span>expLib<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.api.html" class="tsd-signature-type">Api</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#expand">expand</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2072">src/raml1/artifacts/raml10parserapi.ts:2072</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Equivalent API with traits and resource types expanded</p>
</div>
<dl class="tsd-comment-tags">
<dt>explib</dt>
<dd><p>whether to apply library expansion or not</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> expLib: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.api.html" class="tsd-signature-type">Api</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a name="extends" class="tsd-anchor"></a>
<h3>extends</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">extends<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2143">src/raml1/artifacts/raml10parserapi.ts:2143</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Location of a valid RAML API definition (or overlay or extension), the overlay is applied to.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="kind" class="tsd-anchor"></a>
<h3>kind</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">kind<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_highlevelast_.abstractwrappernode.html">AbstractWrapperNode</a>.<a href="_src_raml1_highlevelast_.abstractwrappernode.html#kind">kind</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/highLevelAST.ts#L17">src/raml1/highLevelAST.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>Actual name of instance interface</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="mediatype" class="tsd-anchor"></a>
<h3>media<wbr>Type</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">media<wbr>Type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.mimetype.html" class="tsd-signature-type">MimeType</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#mediatype">mediaType</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2035">src/raml1/artifacts/raml10parserapi.ts:2035</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The default media type to use for request and response bodies (payloads), e.g. "application/json"</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.mimetype.html" class="tsd-signature-type">MimeType</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="meta" class="tsd-anchor"></a>
<h3>meta</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">meta<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_highlevelast_.nodemetadata.html" class="tsd-signature-type">NodeMetadata</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_highlevelast_.basicnode.html">BasicNode</a>.<a href="_src_raml1_highlevelast_.basicnode.html#meta">meta</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/highLevelAST.ts#L91">src/raml1/highLevelAST.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_highlevelast_.nodemetadata.html" class="tsd-signature-type">NodeMetadata</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="optional" class="tsd-anchor"></a>
<h3>optional</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">optional<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_highlevelast_.basicnode.html">BasicNode</a>.<a href="_src_raml1_highlevelast_.basicnode.html#optional">optional</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/highLevelAST.ts#L89">src/raml1/highLevelAST.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>Whether the element is an optional sibling of trait or resource type</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="optionalproperties" class="tsd-anchor"></a>
<h3>optional<wbr>Properties</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">optional<wbr>Properties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_highlevelast_.basicnode.html">BasicNode</a>.<a href="_src_raml1_highlevelast_.basicnode.html#optionalproperties">optionalProperties</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/highLevelAST.ts#L84">src/raml1/highLevelAST.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4>
<p>For siblings of traits or resource types returns an array of optional properties names.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="parent" class="tsd-anchor"></a>
<h3>parent</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">parent<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_highlevelast_.basicnode.html" class="tsd-signature-type">BasicNode</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_highlevelast_.basicnode.html">BasicNode</a>.<a href="_src_raml1_highlevelast_.basicnode.html#parent">parent</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/highLevelAST.ts#L51">src/raml1/highLevelAST.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_highlevelast_.basicnode.html" class="tsd-signature-type">BasicNode</a></h4>
<p>Direct ancestor in RAML hierarchy</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="protocols" class="tsd-anchor"></a>
<h3>protocols</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">protocols<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#protocols">protocols</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2029">src/raml1/artifacts/raml10parserapi.ts:2029</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The protocols supported by the API</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="resourcetypes" class="tsd-anchor"></a>
<h3>resource<wbr>Types</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">resource<wbr>Types<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.resourcetype.html" class="tsd-signature-type">ResourceType</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html">LibraryBase</a>.<a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html#resourcetypes">resourceTypes</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L1958">src/raml1/artifacts/raml10parserapi.ts:1958</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve all resource types including those defined in libraries</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.resourcetype.html" class="tsd-signature-type">ResourceType</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="resources" class="tsd-anchor"></a>
<h3>resources</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">resources<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.resource.html" class="tsd-signature-type">Resource</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#resources">resources</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2047">src/raml1/artifacts/raml10parserapi.ts:2047</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The resources of the API, identified as relative URIs that begin with a slash (/). Every property whose key begins with a slash (/), and is either at the root of the API definition or is the child property of a resource property, is a resource property, e.g.: /users, /{groupId}, etc</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.resource.html" class="tsd-signature-type">Resource</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="runtimedefinition" class="tsd-anchor"></a>
<h3>runtime<wbr>Definition</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">runtime<wbr>Definition<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_node_modules_raml_definition_system_node_modules_raml_typesystem_dist_src_nominal_interfaces_d_.itypedefinition.html" class="tsd-signature-type">ITypeDefinition</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_highlevelast_.basicnode.html">BasicNode</a>.<a href="_src_raml1_highlevelast_.basicnode.html#runtimedefinition">runtimeDefinition</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/highLevelAST.ts#L72">src/raml1/highLevelAST.ts:72</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <a href="_node_modules_raml_definition_system_node_modules_raml_typesystem_dist_src_nominal_interfaces_d_.itypedefinition.html" class="tsd-signature-type">ITypeDefinition</a></h4>
<p>for user class instances returns object representing actual user class</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-external">
<a name="scalarsannotations" class="tsd-anchor"></a>
<h3>scalars<wbr>Annotations</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-external">
<li class="tsd-signature tsd-kind-icon">scalars<wbr>Annotations<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.overlayscalarsannotations.html" class="tsd-signature-type">OverlayScalarsAnnotations</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overwrites <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#scalarsannotations">scalarsAnnotations</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2155">src/raml1/artifacts/raml10parserapi.ts:2155</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Scalar properties annotations accessor</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.overlayscalarsannotations.html" class="tsd-signature-type">OverlayScalarsAnnotations</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="schemas" class="tsd-anchor"></a>
<h3>schemas</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">schemas<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.typedeclaration.html" class="tsd-signature-type">TypeDeclaration</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html">LibraryBase</a>.<a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html#schemas">schemas</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L1921">src/raml1/artifacts/raml10parserapi.ts:1921</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Alias for the equivalent "types" property, for compatibility with RAML 0.8. Deprecated - API definitions should use the "types" property, as the "schemas" alias for that property name may be removed in a future RAML version. The "types" property allows for XML and JSON schemas.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.typedeclaration.html" class="tsd-signature-type">TypeDeclaration</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="securedby" class="tsd-anchor"></a>
<h3>secured<wbr>By</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">secured<wbr>By<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.securityschemeref.html" class="tsd-signature-type">SecuritySchemeRef</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#securedby">securedBy</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2041">src/raml1/artifacts/raml10parserapi.ts:2041</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The security schemes that apply to every resource and method in the API</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.securityschemeref.html" class="tsd-signature-type">SecuritySchemeRef</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="securityschemes" class="tsd-anchor"></a>
<h3>security<wbr>Schemes</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">security<wbr>Schemes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.abstractsecurityscheme.html" class="tsd-signature-type">AbstractSecurityScheme</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html">LibraryBase</a>.<a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html#securityschemes">securitySchemes</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L1939">src/raml1/artifacts/raml10parserapi.ts:1939</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Declarations of security schemes for use within this API.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.abstractsecurityscheme.html" class="tsd-signature-type">AbstractSecurityScheme</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-external">
<a name="title" class="tsd-anchor"></a>
<h3>title</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-external">
<li class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overwrites <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#title">title</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2149">src/raml1/artifacts/raml10parserapi.ts:2149</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Short plain-text label for the API</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="tojson" class="tsd-anchor"></a>
<h3>toJSON</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span>serializeOptions<span class="tsd-signature-symbol">?: </span><a href="_src_raml1_highlevelast_.serializeoptions.html" class="tsd-signature-type">SerializeOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_highlevelast_.basicnode.html">BasicNode</a>.<a href="_src_raml1_highlevelast_.basicnode.html#tojson">toJSON</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/highLevelAST.ts#L79">src/raml1/highLevelAST.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Turns model node into an object.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> serializeOptions: <a href="_src_raml1_highlevelast_.serializeoptions.html" class="tsd-signature-type">SerializeOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
<p>Stringifyable object representation of the node.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="traits" class="tsd-anchor"></a>
<h3>traits</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">traits<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.trait.html" class="tsd-signature-type">Trait</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html">LibraryBase</a>.<a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html#traits">traits</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L1945">src/raml1/artifacts/raml10parserapi.ts:1945</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve all traits including those defined in libraries</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.trait.html" class="tsd-signature-type">Trait</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="types" class="tsd-anchor"></a>
<h3>types</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">types<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.typedeclaration.html" class="tsd-signature-type">TypeDeclaration</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html">LibraryBase</a>.<a href="_src_raml1_artifacts_raml10parserapi_.librarybase.html#types">types</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L1927">src/raml1/artifacts/raml10parserapi.ts:1927</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Declarations of (data) types for use within this API</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.typedeclaration.html" class="tsd-signature-type">TypeDeclaration</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a name="usage" class="tsd-anchor"></a>
<h3>usage</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">usage<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2137">src/raml1/artifacts/raml10parserapi.ts:2137</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>contains description of why overlay exist</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="uses" class="tsd-anchor"></a>
<h3>uses</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">uses<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_raml1_artifacts_raml10parserapi_.usesdeclaration.html" class="tsd-signature-type">UsesDeclaration</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.fragmentdeclaration.html">FragmentDeclaration</a>.<a href="_src_raml1_artifacts_raml10parserapi_.fragmentdeclaration.html#uses">uses</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L1913">src/raml1/artifacts/raml10parserapi.ts:1913</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_src_raml1_artifacts_raml10parserapi_.usesdeclaration.html" class="tsd-signature-type">UsesDeclaration</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="version" class="tsd-anchor"></a>
<h3>version</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_src_raml1_artifacts_raml10parserapi_.api.html">Api</a>.<a href="_src_raml1_artifacts_raml10parserapi_.api.html#version">version</a></p>
<ul>
<li>Defined in <a href="https://github.com/raml-org/raml-js-parser-2/blob/develop/src/raml1/artifacts/raml10parserapi.ts#L2017">src/raml1/artifacts/raml10parserapi.ts:2017</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The version of the API, e.g. 'v1'</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-external-module tsd-is-external">
<a href="../modules/_src_raml1_artifacts_raml10parserapi_.html">"src/raml1/artifacts/raml10parserapi"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html" class="tsd-kind-icon">Overlay</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#ramlversion" class="tsd-kind-icon">RAMLVersion</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#allbaseuriparameters" class="tsd-kind-icon">all<wbr>Base<wbr>Uri<wbr>Parameters</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#allprotocols" class="tsd-kind-icon">all<wbr>Protocols</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#allresourcetypes" class="tsd-kind-icon">all<wbr>Resource<wbr>Types</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#allresources" class="tsd-kind-icon">all<wbr>Resources</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#alltraits" class="tsd-kind-icon">all<wbr>Traits</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#annotationtypes" class="tsd-kind-icon">annotation<wbr>Types</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#annotations" class="tsd-kind-icon">annotations</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#baseuri" class="tsd-kind-icon">base<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#baseuriparameters" class="tsd-kind-icon">base<wbr>Uri<wbr>Parameters</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#childresource" class="tsd-kind-icon">child<wbr>Resource</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#definition" class="tsd-kind-icon">definition</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#description" class="tsd-kind-icon">description</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#documentation" class="tsd-kind-icon">documentation</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#errors" class="tsd-kind-icon">errors</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#expand" class="tsd-kind-icon">expand</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#extends" class="tsd-kind-icon">extends</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#kind" class="tsd-kind-icon">kind</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#mediatype" class="tsd-kind-icon">media<wbr>Type</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#meta" class="tsd-kind-icon">meta</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#optional" class="tsd-kind-icon">optional</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#optionalproperties" class="tsd-kind-icon">optional<wbr>Properties</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#parent" class="tsd-kind-icon">parent</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#protocols" class="tsd-kind-icon">protocols</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#resourcetypes" class="tsd-kind-icon">resource<wbr>Types</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#resources" class="tsd-kind-icon">resources</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#runtimedefinition" class="tsd-kind-icon">runtime<wbr>Definition</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#scalarsannotations" class="tsd-kind-icon">scalars<wbr>Annotations</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#schemas" class="tsd-kind-icon">schemas</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#securedby" class="tsd-kind-icon">secured<wbr>By</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#securityschemes" class="tsd-kind-icon">security<wbr>Schemes</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-overwrite tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#title" class="tsd-kind-icon">title</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#tojson" class="tsd-kind-icon">toJSON</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#traits" class="tsd-kind-icon">traits</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#types" class="tsd-kind-icon">types</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#usage" class="tsd-kind-icon">usage</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#uses" class="tsd-kind-icon">uses</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_src_raml1_artifacts_raml10parserapi_.overlay.html#version" class="tsd-kind-icon">version</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.io" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html> |
<!DOCTYPE html>
<html class="no-js" lang="en-US" prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb#">
<html lang="en" class="js csstransforms3d">
<head>
<meta charset="utf-8">
<meta property="og:title" content="Getting Started with Amazon SageMaker" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://main.d2liw0uxeuzv0b.amplifyapp.com/" />
<meta property="og:image" content="https://main.d2liw0uxeuzv0b.amplifyapp.com/images/setup/image002.png" />
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<meta name="generator" content="Hugo 0.59.0" />
<meta name="description" content="Getting Started with Amazon SageMaker Studio">
<meta name="author" content="Shashank Prasanna">
<link rel="shortcut icon" href="../images/favicon.ico" type="image/x-icon" />
<link rel="icon" href="../images/favicon.ico" type="image/x-icon" />
{0xc000725600 0xc00052f8e0}
<title>Documentation resources :: Getting Started with Amazon SageMaker Studio</title>
<link href="../css/nucleus.css?1620810688" rel="stylesheet">
<link href="../css/fontawesome-all.min.css?1620810688" rel="stylesheet">
<link href="../css/hybrid.css?1620810688" rel="stylesheet">
<link href="../css/featherlight.min.css?1620810688" rel="stylesheet">
<link href="../css/perfect-scrollbar.min.css?1620810688" rel="stylesheet">
<link href="../css/auto-complete.css?1620810688" rel="stylesheet">
<link href="../css/theme.css?1620810688" rel="stylesheet">
<link href="../css/hugo-theme.css?1620810688" rel="stylesheet">
<link href="../css/jquery-ui.min.css?1620810688" rel="stylesheet">
<link href="../css/theme-mine.css?1620810688" rel="stylesheet">
<script src="../js/jquery-3.3.1.min.js?1620810688"></script>
<script src="../js/jquery-ui-1.12.1.min.js?1620810688"></script>
<style type="text/css">
:root #header + #content > #left > #rlblock_left{
display:none !important;
}
</style>
</head>
<body class="" data-url="/appendix/docs.html">
<nav id="sidebar" class="">
<div id="header-wrapper">
<div id="header">
<a href="../" title="Go home"><svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 30" width="60%" style="padding:20px 0px;"><defs><style>.cls-1{fill:#fff;}.cls-2{fill:#f90;fill-rule:evenodd;}</style></defs><title>AWS-Logo_White-Color</title><path class="cls-1" d="M14.09,10.85a4.7,4.7,0,0,0,.19,1.48,7.73,7.73,0,0,0,.54,1.19.77.77,0,0,1,.12.38.64.64,0,0,1-.32.49l-1,.7a.83.83,0,0,1-.44.15.69.69,0,0,1-.49-.23,3.8,3.8,0,0,1-.6-.77q-.25-.42-.51-1a6.14,6.14,0,0,1-4.89,2.3,4.54,4.54,0,0,1-3.32-1.19,4.27,4.27,0,0,1-1.22-3.2A4.28,4.28,0,0,1,3.61,7.75,6.06,6.06,0,0,1,7.69,6.46a12.47,12.47,0,0,1,1.76.13q.92.13,1.91.36V5.73a3.65,3.65,0,0,0-.79-2.66A3.81,3.81,0,0,0,7.86,2.3a7.71,7.71,0,0,0-1.79.22,12.78,12.78,0,0,0-1.79.57,4.55,4.55,0,0,1-.58.22l-.26,0q-.35,0-.35-.52V2a1.09,1.09,0,0,1,.12-.58,1.2,1.2,0,0,1,.47-.35A10.88,10.88,0,0,1,5.77.32,10.19,10.19,0,0,1,8.36,0a6,6,0,0,1,4.35,1.35,5.49,5.49,0,0,1,1.38,4.09ZM7.34,13.38a5.36,5.36,0,0,0,1.72-.31A3.63,3.63,0,0,0,10.63,12,2.62,2.62,0,0,0,11.19,11a5.63,5.63,0,0,0,.16-1.44v-.7a14.35,14.35,0,0,0-1.53-.28,12.37,12.37,0,0,0-1.56-.1,3.84,3.84,0,0,0-2.47.67A2.34,2.34,0,0,0,5,11a2.35,2.35,0,0,0,.61,1.76A2.4,2.4,0,0,0,7.34,13.38Zm13.35,1.8a1,1,0,0,1-.64-.16,1.3,1.3,0,0,1-.35-.65L15.81,1.51a3,3,0,0,1-.15-.67.36.36,0,0,1,.41-.41H17.7a1,1,0,0,1,.65.16,1.4,1.4,0,0,1,.33.65l2.79,11,2.59-11A1.17,1.17,0,0,1,24.39.6a1.1,1.1,0,0,1,.67-.16H26.4a1.1,1.1,0,0,1,.67.16,1.17,1.17,0,0,1,.32.65L30,12.39,32.88,1.25A1.39,1.39,0,0,1,33.22.6a1,1,0,0,1,.65-.16h1.54a.36.36,0,0,1,.41.41,1.36,1.36,0,0,1,0,.26,3.64,3.64,0,0,1-.12.41l-4,12.86a1.3,1.3,0,0,1-.35.65,1,1,0,0,1-.64.16H29.25a1,1,0,0,1-.67-.17,1.26,1.26,0,0,1-.32-.67L25.67,3.64,23.11,14.34a1.26,1.26,0,0,1-.32.67,1,1,0,0,1-.67.17Zm21.36.44a11.28,11.28,0,0,1-2.56-.29,7.44,7.44,0,0,1-1.92-.67,1,1,0,0,1-.61-.93v-.84q0-.52.38-.52a.9.9,0,0,1,.31.06l.42.17a8.77,8.77,0,0,0,1.83.58,9.78,9.78,0,0,0,2,.2,4.48,4.48,0,0,0,2.43-.55,1.76,1.76,0,0,0,.86-1.57,1.61,1.61,0,0,0-.45-1.16A4.29,4.29,0,0,0,43,9.22l-2.41-.76A5.15,5.15,0,0,1,38,6.78a3.94,3.94,0,0,1-.83-2.41,3.7,3.7,0,0,1,.45-1.85,4.47,4.47,0,0,1,1.19-1.37A5.27,5.27,0,0,1,40.51.29,7.4,7.4,0,0,1,42.6,0a8.87,8.87,0,0,1,1.12.07q.57.07,1.08.19t.95.26a4.27,4.27,0,0,1,.7.29,1.59,1.59,0,0,1,.49.41.94.94,0,0,1,.15.55v.79q0,.52-.38.52a1.76,1.76,0,0,1-.64-.2,7.74,7.74,0,0,0-3.2-.64,4.37,4.37,0,0,0-2.21.47,1.6,1.6,0,0,0-.79,1.48,1.58,1.58,0,0,0,.49,1.18,4.94,4.94,0,0,0,1.83.92L44.55,7a5.08,5.08,0,0,1,2.57,1.6A3.76,3.76,0,0,1,47.9,11a4.21,4.21,0,0,1-.44,1.93,4.4,4.4,0,0,1-1.21,1.47,5.43,5.43,0,0,1-1.85.93A8.25,8.25,0,0,1,42.05,15.62Z"></path><path class="cls-2" d="M45.19,23.81C39.72,27.85,31.78,30,25,30A36.64,36.64,0,0,1,.22,20.57c-.51-.46-.06-1.09.56-.74A49.78,49.78,0,0,0,25.53,26.4,49.23,49.23,0,0,0,44.4,22.53C45.32,22.14,46.1,23.14,45.19,23.81Z"></path><path class="cls-2" d="M47.47,21.21c-.7-.9-4.63-.42-6.39-.21-.53.06-.62-.4-.14-.74,3.13-2.2,8.27-1.57,8.86-.83s-.16,5.89-3.09,8.35c-.45.38-.88.18-.68-.32C46.69,25.8,48.17,22.11,47.47,21.21Z"></path></svg></a>
</div>
<div class="searchbox">
<label for="search-by"><i class="fas fa-search"></i></label>
<input data-search-input id="search-by" type="search" placeholder="Search...">
<span data-search-clear=""><i class="fas fa-times"></i></span>
</div>
<script type="text/javascript" src="../js/lunr.min.js?1620810688"></script>
<script type="text/javascript" src="../js/auto-complete.js?1620810688"></script>
<script type="text/javascript">
var baseurl = "";
</script>
<script type="text/javascript" src="../js/search.js?1620810688"></script>
</div>
<div class="highlightable">
<ul class="topics">
<li data-nav-id="/0_introduction.html" title="Workshop Interface Overview" class="dd-item
">
<a href="../0_introduction.html">
<i class="fa fa-film" aria-hidden="true"></i> Workshop Interface Overview
</a>
</li>
<li data-nav-id="/1_setup.html" title="1. Getting started" class="dd-item
">
<a href="../1_setup.html">
1. Getting started
</a>
<ul>
<li data-nav-id="/1_setup/login_aws_account.html" title="1.1 Login to your temporary workshop AWS Account" class="dd-item ">
<a href="../1_setup/login_aws_account.html">
1.1 Login to your temporary workshop AWS Account
</a>
</li>
<li data-nav-id="/1_setup/download_workshop_content.html" title="1.2 Download workshop content" class="dd-item ">
<a href="../1_setup/download_workshop_content.html">
1.2 Download workshop content
</a>
</li>
</ul>
</li>
<li data-nav-id="/2_sagemaker_autopilot.html" title="2. AutoML with SageMaker AutoPilot" class="dd-item
">
<a href="../2_sagemaker_autopilot.html">
2. AutoML with SageMaker AutoPilot
</a>
<ul>
<li data-nav-id="/2_sagemaker_autopilot/dataprep_studio_notebook.html" title="2.1 Data Preparation with Amazon SageMaker Studio Notebook" class="dd-item ">
<a href="../2_sagemaker_autopilot/dataprep_studio_notebook.html">
2.1 Data Preparation with Amazon SageMaker Studio Notebook
</a>
</li>
<li data-nav-id="/2_sagemaker_autopilot/autopilot-workflow.html" title="2.2 Use SageMaker AutoPilot to find the best models" class="dd-item ">
<a href="../2_sagemaker_autopilot/autopilot-workflow.html">
2.2 Use SageMaker AutoPilot to find the best models
</a>
</li>
</ul>
</li>
<li data-nav-id="/3_build-train-tune-deploy.html" title="3. Build, train and tune models with SageMaker built-in algorithms" class="dd-item
">
<a href="../3_build-train-tune-deploy.html">
3. Build, train and tune models with SageMaker built-in algorithms
</a>
<ul>
<li data-nav-id="/3_build-train-tune-deploy/train_xgboost_model.html" title="3.1 Train, tune and deploy an XGBoost model" class="dd-item ">
<a href="../3_build-train-tune-deploy/train_xgboost_model.html">
3.1 Train, tune and deploy an XGBoost model
</a>
</li>
</ul>
</li>
<li data-nav-id="/4_clean-up.html" title="6. Clean up resources" class="dd-item
">
<a href="../4_clean-up.html">
6. Clean up resources
</a>
<ul>
<li data-nav-id="/4_clean-up/cleanup.html" title="Delete all resources" class="dd-item ">
<a href="../4_clean-up/cleanup.html">
Delete all resources
</a>
</li>
</ul>
</li>
<li data-nav-id="/appendix.html" title="Appendix" class="dd-item
parent
">
<a href="../appendix.html">
Appendix
</a>
<ul>
<li data-nav-id="/appendix/docs.html" title="Documentation resources" class="dd-item active">
<a href="../appendix/docs.html">
Documentation resources
</a>
</li>
<li data-nav-id="/appendix/resources.html" title="Technical papers" class="dd-item ">
<a href="../appendix/resources.html">
Technical papers
</a>
</li>
<li data-nav-id="/appendix/blogposts_videos.html" title="Blogposts and videos" class="dd-item ">
<a href="../appendix/blogposts_videos.html">
Blogposts and videos
</a>
</li>
<li data-nav-id="/appendix/example-profiler-report.html" title="Example profiler report" class="dd-item ">
<a href="../appendix/example-profiler-report.html">
Example profiler report
</a>
</li>
</ul>
</li>
</ul>
<section id="footer">
</section>
</div>
</nav>
<section id="body">
<div id="overlay"></div>
<div class="padding highlightable">
<div>
<div id="top-bar">
<div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
<span id="sidebar-toggle-span">
<a href="#" id="sidebar-toggle" data-sidebar-toggle="">
<i class="fas fa-bars"></i>
</a>
</span>
<span id="toc-menu"><i class="fas fa-list-alt"></i></span>
<span class="links">
<a href='../'>Welcome to Getting started with Amazon SageMaker Workshop at AMER Summit</a> > <a href='../appendix.html'>Appendix</a> > Documentation resources
</span>
</div>
<div class="progress">
<div class="wrapper">
<nav id="TableOfContents">
<ul>
<li>
<ul>
<li>
<ul>
<li>
<ul>
<li><a href="#1-sagemaker-sdk-api-guide">1. SageMaker SDK API guide</a></li>
<li><a href="#2-sagemaker-sample-notebooks-on-github">2. SageMaker Sample Notebooks on GitHub</a></li>
<li><a href="#3-sagemaker-developer-guide">3. SageMaker Developer Guide</a></li>
<li><a href="#4-sagemaker-api-reference">4. SageMaker API Reference</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="body-inner">
<h1>Documentation resources</h1>
<h4 id="1-sagemaker-sdk-api-guide">1. SageMaker SDK API guide</h4>
<p><a href="https://sagemaker.readthedocs.io/en/stable/" target="_blank">https://sagemaker.readthedocs.io/en/stable/</a></p>
<h4 id="2-sagemaker-sample-notebooks-on-github">2. SageMaker Sample Notebooks on GitHub</h4>
<p><a href="https://github.com/awslabs/amazon-sagemaker-examples" target="_blank">https://github.com/awslabs/amazon-sagemaker-examples</a></p>
<h4 id="3-sagemaker-developer-guide">3. SageMaker Developer Guide</h4>
<p><a href="https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html" target="_blank">https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html</a></p>
<h4 id="4-sagemaker-api-reference">4. SageMaker API Reference</h4>
<p><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Operations_Amazon_SageMaker_Service.html" target="_blank">https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Operations_Amazon_SageMaker_Service.html</a></p>
<footer class="footline">
</footer>
</div>
</div>
<div id="navigation">
<a class="nav nav-prev" href="../appendix.html" title="Appendix"> <i class="fas fa-chevron-left"></i></a>
<a class="nav nav-next" href="../appendix/resources.html" title="Technical papers" style="margin-right: 0px;"><i class="fas fa-chevron-right"></i></a>
</div>
</section>
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
<script src="../js/clipboard.min.js?1620810688"></script>
<script src="../js/perfect-scrollbar.min.js?1620810688"></script>
<script src="../js/perfect-scrollbar.jquery.min.js?1620810688"></script>
<script src="../js/jquery.sticky.js?1620810688"></script>
<script src="../js/featherlight.min.js?1620810688"></script>
<script src="../js/highlight.pack.js?1620810688"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="../js/modernizr.custom-3.6.0.js?1620810688"></script>
<script src="../js/learn.js?1620810688"></script>
<script src="../js/hugo-learn.js?1620810688"></script>
<link href="../mermaid/mermaid.css?1620810688" type="text/css" rel="stylesheet" />
<script src="../mermaid/mermaid.min.js?1620810688"></script>
<script>
var config = {
startOnLoad:true,
flowchart:{
curve:'basis'
}
};
mermaid.initialize(config);
</script>
<script type="text/javascript" src="https://eventbox.dev/js/injectOverlay.js"></script>
</body>
</html>
|
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" type="text/css" href="../style.css">
</head>
<body>
<h1>DBConcatExpr.java</h1>
<table class="src">
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_1'/>
1
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_1'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>/*</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_2'/>
2
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_2'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * Licensed to the Apache Software Foundation (ASF) under one</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_3'/>
3
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_3'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * or more contributor license agreements. See the NOTICE file</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_4'/>
4
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_4'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * distributed with this work for additional information</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_5'/>
5
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_5'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * regarding copyright ownership. The ASF licenses this file</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_6'/>
6
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_6'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * to you under the Apache License, Version 2.0 (the</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_7'/>
7
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_7'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * "License"); you may not use this file except in compliance</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_8'/>
8
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_8'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * with the License. You may obtain a copy of the License at</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_9'/>
9
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_9'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> *</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_10'/>
10
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_10'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * http://www.apache.org/licenses/LICENSE-2.0</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_11'/>
11
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_11'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> *</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_12'/>
12
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_12'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * Unless required by applicable law or agreed to in writing,</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_13'/>
13
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_13'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * software distributed under the License is distributed on an</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_14'/>
14
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_14'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_15'/>
15
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_15'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * KIND, either express or implied. See the License for the</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_16'/>
16
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_16'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * specific language governing permissions and limitations</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_17'/>
17
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_17'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * under the License.</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_18'/>
18
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_18'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> */</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_19'/>
19
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_19'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>package org.apache.empire.db.expr.column;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_20'/>
20
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_20'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_21'/>
21
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_21'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>// Java</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_22'/>
22
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_22'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>import org.apache.empire.data.DataType;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_23'/>
23
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_23'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>import org.apache.empire.db.DBColumn;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_24'/>
24
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_24'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>import org.apache.empire.db.DBColumnExpr;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_25'/>
25
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_25'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>import org.apache.empire.db.DBDatabase;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_26'/>
26
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_26'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>import org.apache.empire.db.DBDatabaseDriver;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_27'/>
27
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_27'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>import org.apache.empire.db.DBExpr;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_28'/>
28
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_28'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>import org.apache.empire.xml.XMLUtil;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_29'/>
29
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_29'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>import org.w3c.dom.Element;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_30'/>
30
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_30'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_31'/>
31
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_31'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>import java.text.MessageFormat;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_32'/>
32
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_32'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>import java.util.Set;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_33'/>
33
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_33'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_34'/>
34
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_34'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_35'/>
35
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_35'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>/**</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_36'/>
36
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_36'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * This class is used for performing string concatenation in SQL<br></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_37'/>
37
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_37'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * <P></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_38'/>
38
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_38'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * There is no need to explicitly create instances of this class.<BR></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_39'/>
39
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_39'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * Instead use {@link DBColumnExpr#append(Object) }</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_40'/>
40
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_40'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * <P></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_41'/>
41
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_41'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> */</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_42'/>
42
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_42'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>public class DBConcatExpr extends DBColumnExpr</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_43'/>
43
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_43'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>{</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_44'/>
44
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_44'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> private final static long serialVersionUID = 1L;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_45'/>
45
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_45'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> </span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_46'/>
46
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_46'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> protected final DBColumnExpr left;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_47'/>
47
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_47'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> protected final Object right;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_48'/>
48
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_48'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_49'/>
49
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_49'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> /**</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_50'/>
50
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_50'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * Constructs a new DBConcatExpr object set the specified parameters to this object.</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_51'/>
51
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_51'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * </span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_52'/>
52
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_52'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * @param left the left column for this concatenation</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_53'/>
53
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_53'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * @param right the right column for this concatenation</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_54'/>
54
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_54'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> */</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_55'/>
55
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_55'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> public DBConcatExpr(DBColumnExpr left, Object right)</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_56'/>
56
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_56'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> {</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_57'/>
57
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_57'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> this.left = left;</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_58'/>
58
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_58'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> this.right = right;</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_59'/>
59
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_59'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> }</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_60'/>
60
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_60'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_61'/>
61
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_61'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> @Override</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_62'/>
62
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_62'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> public DBDatabase getDatabase()</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_63'/>
63
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_63'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> {</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_64'/>
64
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_64'>1</a>
<span>
1. getDatabase : replaced return value with null for org/apache/empire/db/expr/column/DBConcatExpr::getDatabase → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> return left.getDatabase();</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_65'/>
65
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_65'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> }</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_66'/>
66
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_66'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_67'/>
67
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_67'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> /**</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_68'/>
68
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_68'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * Returns the data type: {@link DataType#TEXT}</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_69'/>
69
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_69'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * </span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_70'/>
70
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_70'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * @return {@link DataType#TEXT}</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_71'/>
71
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_71'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> */</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_72'/>
72
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_72'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> @Override</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_73'/>
73
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_73'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> public DataType getDataType()</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_74'/>
74
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_74'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> {</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_75'/>
75
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_75'>1</a>
<span>
1. getDataType : replaced return value with null for org/apache/empire/db/expr/column/DBConcatExpr::getDataType → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> return DataType.VARCHAR;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_76'/>
76
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_76'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> }</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_77'/>
77
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_77'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_78'/>
78
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_78'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> @Override</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_79'/>
79
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_79'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> public String getName()</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_80'/>
80
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_80'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> { // Get the expression name</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_81'/>
81
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_81'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> String name = left.getName();</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_82'/>
82
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_82'>1</a>
<span>
1. getName : negated conditional → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> if (right instanceof DBColumnExpr)</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_83'/>
83
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_83'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> { // add other names</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_84'/>
84
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_84'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> name += "_";</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_85'/>
85
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_85'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> name += ((DBColumnExpr) right).getName();</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_86'/>
86
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_86'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> }</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_87'/>
87
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_87'>1</a>
<span>
1. getName : replaced return value with "" for org/apache/empire/db/expr/column/DBConcatExpr::getName → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> return name;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_88'/>
88
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_88'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> }</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_89'/>
89
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_89'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_90'/>
90
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_90'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> @Override</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_91'/>
91
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_91'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> public Element addXml(Element parent, long flags)</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_92'/>
92
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_92'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> {</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_93'/>
93
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_93'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> Element elem = XMLUtil.addElement(parent, "column");</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_94'/>
94
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_94'>1</a>
<span>
1. addXml : removed call to org/w3c/dom/Element::setAttribute → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> elem.setAttribute("name", getName());</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_95'/>
95
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_95'>1</a>
<span>
1. addXml : removed call to org/w3c/dom/Element::setAttribute → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> elem.setAttribute("function", "concat");</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_96'/>
96
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_96'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> // Add Other Attributes</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_97'/>
97
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_97'>1</a>
<span>
1. addXml : negated conditional → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> if (attributes!=null)</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_98'/>
98
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_98'>1</a>
<span>
1. addXml : removed call to org/apache/empire/commons/Attributes::addXml → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> attributes.addXml(elem, flags);</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_99'/>
99
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_99'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> // add All Options</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_100'/>
100
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_100'>1</a>
<span>
1. addXml : negated conditional → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> if (options!=null)</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_101'/>
101
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_101'>1</a>
<span>
1. addXml : removed call to org/apache/empire/commons/Options::addXml → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> options.addXml(elem, flags);</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_102'/>
102
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_102'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> // Done</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_103'/>
103
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_103'>1</a>
<span>
1. addXml : replaced return value with null for org/apache/empire/db/expr/column/DBConcatExpr::addXml → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> return elem;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_104'/>
104
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_104'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> }</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_105'/>
105
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_105'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_106'/>
106
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_106'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> @Override</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_107'/>
107
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_107'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> public DBColumn getUpdateColumn()</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_108'/>
108
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_108'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> {</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_109'/>
109
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_109'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> return null;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_110'/>
110
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_110'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> }</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_111'/>
111
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_111'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_112'/>
112
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_112'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> /**</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_113'/>
113
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_113'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * Always returns false since a concat expression cannot be an aggregate.</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_114'/>
114
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_114'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * </span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_115'/>
115
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_115'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * @return false</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_116'/>
116
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_116'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> */</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_117'/>
117
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_117'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> @Override</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_118'/>
118
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_118'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> public boolean isAggregate()</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_119'/>
119
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_119'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> {</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_120'/>
120
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_120'>1</a>
<span>
1. isAggregate : replaced boolean return with true for org/apache/empire/db/expr/column/DBConcatExpr::isAggregate → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> return false;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_121'/>
121
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_121'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> }</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_122'/>
122
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_122'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_123'/>
123
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_123'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> /**</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_124'/>
124
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_124'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * @see org.apache.empire.db.DBExpr#addReferencedColumns(Set)</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_125'/>
125
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_125'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> */</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_126'/>
126
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_126'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> @Override</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_127'/>
127
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_127'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> public void addReferencedColumns(Set<DBColumn> list)</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_128'/>
128
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_128'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> {</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_129'/>
129
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_129'>1</a>
<span>
1. addReferencedColumns : removed call to org/apache/empire/db/DBColumnExpr::addReferencedColumns → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> left.addReferencedColumns(list);</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_130'/>
130
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_130'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> // Check if right object is a DBExpr</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_131'/>
131
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_131'>1</a>
<span>
1. addReferencedColumns : negated conditional → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> if (right instanceof DBExpr)</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_132'/>
132
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_132'>1</a>
<span>
1. addReferencedColumns : removed call to org/apache/empire/db/DBExpr::addReferencedColumns → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> ((DBExpr)right).addReferencedColumns(list);</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_133'/>
133
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_133'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> }</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_134'/>
134
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_134'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''></span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_135'/>
135
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_135'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> /**</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_136'/>
136
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_136'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * Creates the SQL-Command concatenate a specified column with</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_137'/>
137
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_137'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * a specified value sets the column with a specified value to</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_138'/>
138
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_138'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * the SQL-Command.</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_139'/>
139
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_139'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * </span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_140'/>
140
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_140'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * @param buf the SQL statment</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_141'/>
141
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_141'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> * @param context the current SQL-Command context</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_142'/>
142
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_142'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> */</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_143'/>
143
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_143'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> @Override</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_144'/>
144
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_144'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> public void addSQL(StringBuilder buf, long context)</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_145'/>
145
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_145'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> { // Zusammenbauen</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_146'/>
146
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_146'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> String template = getDatabase().getDriver().getSQLPhrase(DBDatabaseDriver.SQL_CONCAT_EXPR);</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_147'/>
147
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_147'>1</a>
<span>
1. addSQL : Replaced bitwise AND with OR → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> context &= ~CTX_ALIAS; // No column aliases</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_148'/>
148
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_148'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> // Find Separator</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_149'/>
149
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_149'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> int sep = template.indexOf('?');</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_150'/>
150
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_150'>2</a>
<span>
1. addSQL : changed conditional boundary → NO_COVERAGE<br/>
2. addSQL : negated conditional → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> if (sep >= 0)</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_151'/>
151
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_151'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> { // Complex Pattern with placeholder ? for this expression and {0} for the value</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_152'/>
152
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_152'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> buf.append(template.substring(0, sep));</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_153'/>
153
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_153'>1</a>
<span>
1. addSQL : removed call to org/apache/empire/db/DBColumnExpr::addSQL → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> left.addSQL(buf, context);</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_154'/>
154
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_154'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> String value = getObjectValue(getDataType(), right, context, ", ");</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_155'/>
155
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_155'>1</a>
<span>
1. addSQL : Replaced integer addition with subtraction → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> buf.append(MessageFormat.format(template.substring(sep + 1), value));</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_156'/>
156
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_156'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> } </span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_157'/>
157
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_157'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> else</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_158'/>
158
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_158'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> { // Simple Pattern without placeholders</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_159'/>
159
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_159'>1</a>
<span>
1. addSQL : removed call to org/apache/empire/db/DBColumnExpr::addSQL → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> left.addSQL(buf, context);</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_160'/>
160
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_160'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> buf.append(template);</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_161'/>
161
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_161'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> buf.append(getObjectValue(getDataType(), right, context, template));</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_162'/>
162
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_162'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> }</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_163'/>
163
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_163'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> </span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_164'/>
164
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_164'></a>
<span>
</span>
</span>
</td>
<td class='uncovered'><pre><span class=''> }</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_165'/>
165
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_165'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> </span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_166'/>
166
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_166'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> @Override</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_167'/>
167
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_167'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> public boolean equals(Object other)</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_168'/>
168
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_168'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> {</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_169'/>
169
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_169'>1</a>
<span>
1. equals : negated conditional → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> 	if (other instanceof DBConcatExpr)</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_170'/>
170
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_170'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> 	{	// Compare left and right</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_171'/>
171
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_171'>2</a>
<span>
1. equals : replaced boolean return with true for org/apache/empire/db/expr/column/DBConcatExpr::equals → NO_COVERAGE<br/>
2. equals : negated conditional → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> 		return left .equals(((DBConcatExpr)other).left)</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_172'/>
172
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_172'>1</a>
<span>
1. equals : negated conditional → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> 		 && right.equals(((DBConcatExpr)other).right);</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_173'/>
173
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_173'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> 	}</span></pre></td></tr>
<tr>
<td class='uncovered'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_174'/>
174
</td>
<td class='survived'>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_174'>1</a>
<span>
1. equals : replaced boolean return with true for org/apache/empire/db/expr/column/DBConcatExpr::equals → NO_COVERAGE<br/>
</span>
</span>
</td>
<td class='uncovered'><pre><span class='survived'> 	return false;</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_175'/>
175
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_175'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''> }</span></pre></td></tr>
<tr>
<td class='na'>
<a name='org.pitest.mutationtest.report.html.SourceFile@71062d22_176'/>
176
</td>
<td class=''>
<span class='pop'>
<a href='#grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_176'></a>
<span>
</span>
</span>
</td>
<td class=''><pre><span class=''>}</span></pre></td></tr>
<tr><td></td><td></td><td><h2>Mutations</h2></td></tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_64'>64</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_64'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>getDatabase<br/><b>Killed by : </b>none</span></span> replaced return value with null for org/apache/empire/db/expr/column/DBConcatExpr::getDatabase → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_75'>75</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_75'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>getDataType<br/><b>Killed by : </b>none</span></span> replaced return value with null for org/apache/empire/db/expr/column/DBConcatExpr::getDataType → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_82'>82</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_82'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>getName<br/><b>Killed by : </b>none</span></span> negated conditional → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_87'>87</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_87'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>getName<br/><b>Killed by : </b>none</span></span> replaced return value with "" for org/apache/empire/db/expr/column/DBConcatExpr::getName → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_94'>94</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_94'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addXml<br/><b>Killed by : </b>none</span></span> removed call to org/w3c/dom/Element::setAttribute → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_95'>95</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_95'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addXml<br/><b>Killed by : </b>none</span></span> removed call to org/w3c/dom/Element::setAttribute → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_97'>97</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_97'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addXml<br/><b>Killed by : </b>none</span></span> negated conditional → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_98'>98</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_98'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addXml<br/><b>Killed by : </b>none</span></span> removed call to org/apache/empire/commons/Attributes::addXml → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_100'>100</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_100'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addXml<br/><b>Killed by : </b>none</span></span> negated conditional → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_101'>101</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_101'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addXml<br/><b>Killed by : </b>none</span></span> removed call to org/apache/empire/commons/Options::addXml → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_103'>103</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_103'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addXml<br/><b>Killed by : </b>none</span></span> replaced return value with null for org/apache/empire/db/expr/column/DBConcatExpr::addXml → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_120'>120</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_120'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>isAggregate<br/><b>Killed by : </b>none</span></span> replaced boolean return with true for org/apache/empire/db/expr/column/DBConcatExpr::isAggregate → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_129'>129</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_129'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addReferencedColumns<br/><b>Killed by : </b>none</span></span> removed call to org/apache/empire/db/DBColumnExpr::addReferencedColumns → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_131'>131</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_131'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addReferencedColumns<br/><b>Killed by : </b>none</span></span> negated conditional → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_132'>132</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_132'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addReferencedColumns<br/><b>Killed by : </b>none</span></span> removed call to org/apache/empire/db/DBExpr::addReferencedColumns → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_147'>147</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_147'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addSQL<br/><b>Killed by : </b>none</span></span> Replaced bitwise AND with OR → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_150'>150</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_150'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addSQL<br/><b>Killed by : </b>none</span></span> changed conditional boundary → NO_COVERAGE</p> <p class='NO_COVERAGE'><span class='pop'>2.<span><b>2</b><br/><b>Location : </b>addSQL<br/><b>Killed by : </b>none</span></span> negated conditional → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_153'>153</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_153'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addSQL<br/><b>Killed by : </b>none</span></span> removed call to org/apache/empire/db/DBColumnExpr::addSQL → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_155'>155</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_155'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addSQL<br/><b>Killed by : </b>none</span></span> Replaced integer addition with subtraction → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_159'>159</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_159'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>addSQL<br/><b>Killed by : </b>none</span></span> removed call to org/apache/empire/db/DBColumnExpr::addSQL → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_169'>169</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_169'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>equals<br/><b>Killed by : </b>none</span></span> negated conditional → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_171'>171</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_171'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>equals<br/><b>Killed by : </b>none</span></span> replaced boolean return with true for org/apache/empire/db/expr/column/DBConcatExpr::equals → NO_COVERAGE</p> <p class='NO_COVERAGE'><span class='pop'>2.<span><b>2</b><br/><b>Location : </b>equals<br/><b>Killed by : </b>none</span></span> negated conditional → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_172'>172</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_172'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>equals<br/><b>Killed by : </b>none</span></span> negated conditional → NO_COVERAGE</p>
</td>
</tr>
<tr>
<td><a href='#org.pitest.mutationtest.report.html.SourceFile@71062d22_174'>174</a></td>
<td></td>
<td>
<a name='grouporg.pitest.mutationtest.report.html.SourceFile@71062d22_174'/>
<p class='NO_COVERAGE'><span class='pop'>1.<span><b>1</b><br/><b>Location : </b>equals<br/><b>Killed by : </b>none</span></span> replaced boolean return with true for org/apache/empire/db/expr/column/DBConcatExpr::equals → NO_COVERAGE</p>
</td>
</tr>
</table>
<h2>Active mutators</h2>
<ul>
<li class='mutator'>BOOLEAN_FALSE_RETURN</li>
<li class='mutator'>BOOLEAN_TRUE_RETURN</li>
<li class='mutator'>CONDITIONALS_BOUNDARY_MUTATOR</li>
<li class='mutator'>EMPTY_RETURN_VALUES</li>
<li class='mutator'>INCREMENTS_MUTATOR</li>
<li class='mutator'>INVERT_NEGS_MUTATOR</li>
<li class='mutator'>MATH_MUTATOR</li>
<li class='mutator'>NEGATE_CONDITIONALS_MUTATOR</li>
<li class='mutator'>NULL_RETURN_VALUES</li>
<li class='mutator'>PRIMITIVE_RETURN_VALS_MUTATOR</li>
<li class='mutator'>VOID_METHOD_CALL_MUTATOR</li>
</ul>
<h2>Tests examined</h2>
<ul>
</ul>
<br/>
Report generated by <a href='http://pitest.org'>PIT</a> 1.5.2
</body>
</html> |
<!DOCTYPE html>
<html lang="en" class="js csstransforms3d">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Hugo 0.78.0" />
<meta name="description" content="JFrog Workshop with Google Cloud">
<meta name="author" content="JFrog">
<link rel="icon" href="https://jfrogtraining.github.io/clouddays/images/favicon.png" type="image/png">
<title>Setup Workshop :: JFrog DevOps Modernization Workshop</title>
<link href="https://jfrogtraining.github.io/clouddays/css/nucleus.css?1604857486" rel="stylesheet">
<link href="https://jfrogtraining.github.io/clouddays/css/fontawesome-all.min.css?1604857486" rel="stylesheet">
<link href="https://jfrogtraining.github.io/clouddays/css/hybrid.css?1604857486" rel="stylesheet">
<link href="https://jfrogtraining.github.io/clouddays/css/featherlight.min.css?1604857486" rel="stylesheet">
<link href="https://jfrogtraining.github.io/clouddays/css/perfect-scrollbar.min.css?1604857486" rel="stylesheet">
<link href="https://jfrogtraining.github.io/clouddays/css/auto-complete.css?1604857486" rel="stylesheet">
<link href="https://jfrogtraining.github.io/clouddays/css/atom-one-dark-reasonable.css?1604857486" rel="stylesheet">
<link href="https://jfrogtraining.github.io/clouddays/css/theme.css?1604857486" rel="stylesheet">
<link href="https://jfrogtraining.github.io/clouddays/css/hugo-theme.css?1604857486" rel="stylesheet">
<link href="https://jfrogtraining.github.io/clouddays/css/theme-mine.css?1604857486" rel="stylesheet">
<script src="https://jfrogtraining.github.io/clouddays/js/jquery-3.3.1.min.js?1604857486"></script>
<style>
:root #header + #content > #left > #rlblock_left{
display:none !important;
}
</style>
</head>
<body class="" data-url="https://jfrogtraining.github.io/clouddays/4_workshop_setup.html">
<nav id="sidebar" class="showVisitedLinks">
<div id="header-wrapper">
<div id="header">
<a href="https://jfrogtraining.github.io/clouddays/" title="Go home"><img src="https://jfrogtraining.github.io/clouddays/images/gcp/Google-Cloud-Logo.png" /></a>
</div>
<div class="searchbox">
<label for="search-by"><i class="fas fa-search"></i></label>
<input data-search-input id="search-by" type="search" placeholder="Search...">
<span data-search-clear=""><i class="fas fa-times"></i></span>
</div>
<script type="text/javascript" src="https://jfrogtraining.github.io/clouddays/js/lunr.min.js?1604857486"></script>
<script type="text/javascript" src="https://jfrogtraining.github.io/clouddays/js/auto-complete.js?1604857486"></script>
<script type="text/javascript">
var baseurl = "https:\/\/jfrogtraining.github.io\/clouddays\/";
</script>
<script type="text/javascript" src="https://jfrogtraining.github.io/clouddays/js/search.js?1604857486"></script>
</div>
<div class="highlightable">
<ul class="topics">
<li data-nav-id="/1_prerequisites.html" title="Prerequisites" class="dd-item
">
<a href="https://jfrogtraining.github.io/clouddays/1_prerequisites.html">
<b>1 </b>Prerequisites
<i class="fas fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/1_prerequisites/11_google_cloud_account.html" title="Google Cloud Account" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/1_prerequisites/11_google_cloud_account.html">
<b>11 </b>Google Cloud Account
<i class="fas fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/1_prerequisites/12_jfrog_free_tier.html" title="JFrog Free Tier (No CC Required)" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/1_prerequisites/12_jfrog_free_tier.html">
<b>12 </b>JFrog Free Tier (No CC Required)
<i class="fas fa-check read-icon"></i>
</a>
</li>
</ul>
</li>
<li data-nav-id="/2_devops_cloud.html" title="DevOps in the Cloud" class="dd-item
">
<a href="https://jfrogtraining.github.io/clouddays/2_devops_cloud.html">
<b>2 </b>DevOps in the Cloud
<i class="fas fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/2_devops_cloud/21_continuous_integration_and_delivery.html" title="Continuous Integration and Delivery" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/2_devops_cloud/21_continuous_integration_and_delivery.html">
<b>2.1 </b>Continuous Integration and Delivery
<i class="fas fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/2_devops_cloud/22_binary_repository_management.html" title="Binary Repository Management" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/2_devops_cloud/22_binary_repository_management.html">
<b>2.2 </b>Binary Repository Management
<i class="fas fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/2_devops_cloud/23_dev_sec_ops.html" title="DevSecOps" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/2_devops_cloud/23_dev_sec_ops.html">
<b>2.3 </b>DevSecOps
<i class="fas fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/2_devops_cloud/24_jfrog_platform_overview.html" title="JFrog Platform for DevOps in the Cloud" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/2_devops_cloud/24_jfrog_platform_overview.html">
<b>2.4 </b>JFrog Platform for DevOps in the Cloud
<i class="fas fa-check read-icon"></i>
</a>
</li>
</ul>
</li>
<li data-nav-id="/3_workshop.html" title="Workshop Overview" class="dd-item
">
<a href="https://jfrogtraining.github.io/clouddays/3_workshop.html">
<b>3 </b>Workshop Overview
<i class="fas fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/4_workshop_setup.html" title="Setup Workshop" class="dd-item
parent
active
">
<a href="https://jfrogtraining.github.io/clouddays/4_workshop_setup.html">
<b>4 </b>Setup Workshop
<i class="fas fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/4_workshop_setup/41_start_gcp_cloud_shell.html" title="Start Cloud Shell" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/4_workshop_setup/41_start_gcp_cloud_shell.html">
<b>4.1 </b>Start Cloud Shell
<i class="fas fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/4_workshop_setup/42_start_gke_cluster.html" title="Start GKE Cluster" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/4_workshop_setup/42_start_gke_cluster.html">
<b>4.2 </b>Start GKE Cluster
<i class="fas fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/4_workshop_setup/43_create_docker_repo.html" title="Start GKE Cluster" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/4_workshop_setup/43_create_docker_repo.html">
<b>4.3 </b>Start GKE Cluster
<i class="fas fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/4_workshop_setup/44_get_artifactory_api_key.html" title="Start GKE Cluster" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/4_workshop_setup/44_get_artifactory_api_key.html">
<b>4.4 </b>Start GKE Cluster
<i class="fas fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/4_workshop_setup/45_declare_variables.html" title="Declare environment variables" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/4_workshop_setup/45_declare_variables.html">
<b>4.5 </b>Declare environment variables
<i class="fas fa-check read-icon"></i>
</a>
</li>
</ul>
</li>
<li data-nav-id="/5_build_publish_app.html" title="Build and Publish the App" class="dd-item
">
<a href="https://jfrogtraining.github.io/clouddays/5_build_publish_app.html">
<b>5 </b>Build and Publish the App
<i class="fas fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/5_build_publish_app/51_build_and_push_jfrog_cli_docker_image-copy.html" title="Build and Push JFrog CLI Docker Image" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/5_build_publish_app/51_build_and_push_jfrog_cli_docker_image-copy.html">
<b>5.1 </b>Build and Push JFrog CLI Docker Image
<i class="fas fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/5_build_publish_app/52_build_and_push_npm_docker_image.html" title="Build and Push JFrog CLI Docker Image" class="dd-item ">
<a href="https://jfrogtraining.github.io/clouddays/5_build_publish_app/52_build_and_push_npm_docker_image.html">
<b>5.2 </b>Build and Push JFrog CLI Docker Image
<i class="fas fa-check read-icon"></i>
</a>
</li>
</ul>
</li>
<li data-nav-id="/6_deploy_gke.html" title="Deploy Application on GKE" class="dd-item
">
<a href="https://jfrogtraining.github.io/clouddays/6_deploy_gke.html">
<b>6.0 </b>Deploy Application on GKE
<i class="fas fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/7_conclusion.html" title="Conclusion" class="dd-item
">
<a href="https://jfrogtraining.github.io/clouddays/7_conclusion.html">
<b>7.0 </b>Conclusion
<i class="fas fa-check read-icon"></i>
</a>
</li>
</ul>
<section id="shortcuts">
<h3>More</h3>
<ul>
<li>
<a class="padding" href="https://jfrogtraining.github.io/clouddays/cleanup.html"><i class='fas fa-trash-alt'></i> Cleanup</a>
</li>
<li>
<a class="padding" href="https://github.com/jfrogtraining/clouddays/"><i class='fab fa-fw fa-github'></i> GitHub repo</a>
</li>
<li>
<a class="padding" href="https://jfrogtraining.github.io/clouddays/resources.html"><i class='fab fa-readme'></i> Resources</a>
</li>
</ul>
</section>
<section id="prefooter">
<hr/>
<ul>
<li><a class="padding" href="#" data-clear-history-toggle=""><i class="fas fa-history fa-fw"></i> Clear History</a></li>
</ul>
</section>
<section id="footer">
<left>
<h5 class="copyright">© 2020 JFrog, Inc. or its Affiliates. All rights reserved.<h5>
</left>
</section>
</div>
</nav>
<section id="body">
<div id="overlay"></div>
<div class="padding highlightable">
<div>
<div id="top-bar">
<div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
<span id="sidebar-toggle-span">
<a href="#" id="sidebar-toggle" data-sidebar-toggle="">
<i class="fas fa-bars"></i>
</a>
</span>
<span id="toc-menu"><i class="fas fa-list-alt"></i></span>
<span class="links">
<a href='https://jfrogtraining.github.io/clouddays/'>JFrog DevOps Google Cloud Workshop</a> > Setup Workshop
</span>
</div>
<div class="progress">
<div class="wrapper">
<nav id="TableOfContents"></nav>
</div>
</div>
</div>
</div>
<div id="head-tags">
</div>
<div id="body-inner">
<h1>
Setup Workshop
</h1>
<p>To setup workshop, we will perform two steps</p>
<ul>
<li>
<p>Start a google cloud shell</p>
</li>
<li>
<p>Start a GKE Cluster</p>
</li>
</ul>
<div class="notices warning" ><p>This Google cloud account will expire at the end of the workshop and any resources will automatically be de-provisioned. You will not be able to access this account after today.</p>
</div>
<footer class=" footline" >
</footer>
</div>
</div>
<div id="navigation">
<a class="nav nav-prev" href="https://jfrogtraining.github.io/clouddays/3_workshop.html" title="Workshop Overview"> <i class="fa fa-chevron-left"></i></a>
<a class="nav nav-next" href="https://jfrogtraining.github.io/clouddays/4_workshop_setup/41_start_gcp_cloud_shell.html" title="Start Cloud Shell" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>
</div>
</section>
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
<script src="https://jfrogtraining.github.io/clouddays/js/clipboard.min.js?1604857486"></script>
<script src="https://jfrogtraining.github.io/clouddays/js/perfect-scrollbar.min.js?1604857486"></script>
<script src="https://jfrogtraining.github.io/clouddays/js/perfect-scrollbar.jquery.min.js?1604857486"></script>
<script src="https://jfrogtraining.github.io/clouddays/js/jquery.sticky.js?1604857486"></script>
<script src="https://jfrogtraining.github.io/clouddays/js/featherlight.min.js?1604857486"></script>
<script src="https://jfrogtraining.github.io/clouddays/js/highlight.pack.js?1604857486"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="https://jfrogtraining.github.io/clouddays/js/modernizr.custom-3.6.0.js?1604857486"></script>
<script src="https://jfrogtraining.github.io/clouddays/js/learn.js?1604857486"></script>
<script src="https://jfrogtraining.github.io/clouddays/js/hugo-learn.js?1604857486"></script>
<script src="https://jfrogtraining.github.io/clouddays/mermaid/mermaid.js?1604857486"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>
</body>
</html>
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>local2global.utils.relative_orthogonal_transform — local2global 1.0 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="../_static/gallery-binder.css" type="text/css" />
<link rel="stylesheet" href="../_static/gallery-dataframe.css" type="text/css" />
<link rel="stylesheet" href="../_static/gallery-rendered-html.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="local2global.utils.relative_scale" href="local2global.utils.relative_scale.html" />
<link rel="prev" title="local2global.utils.procrustes_error" href="local2global.utils.procrustes_error.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home"> local2global
</a>
<div class="version">
1.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage/usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../test.html">Tests</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../reference.html">Reference</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="local2global.utils.html">local2global.utils</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="local2global.utils.ensure_extension.html">local2global.utils.ensure_extension</a></li>
<li class="toctree-l3"><a class="reference internal" href="local2global.utils.nearest_orthogonal.html">local2global.utils.nearest_orthogonal</a></li>
<li class="toctree-l3"><a class="reference internal" href="local2global.utils.orthogonal_MSE_error.html">local2global.utils.orthogonal_MSE_error</a></li>
<li class="toctree-l3"><a class="reference internal" href="local2global.utils.procrustes_error.html">local2global.utils.procrustes_error</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">local2global.utils.relative_orthogonal_transform</a></li>
<li class="toctree-l3"><a class="reference internal" href="local2global.utils.relative_scale.html">local2global.utils.relative_scale</a></li>
<li class="toctree-l3"><a class="reference internal" href="local2global.utils.seed.html">local2global.utils.seed</a></li>
<li class="toctree-l3"><a class="reference internal" href="local2global.utils.transform_error.html">local2global.utils.transform_error</a></li>
<li class="toctree-l3"><a class="reference internal" href="local2global.utils.AlignmentProblem.html">local2global.utils.AlignmentProblem</a></li>
<li class="toctree-l3"><a class="reference internal" href="local2global.utils.Patch.html">local2global.utils.Patch</a></li>
<li class="toctree-l3"><a class="reference internal" href="local2global.utils.WeightedAlignmentProblem.html">local2global.utils.WeightedAlignmentProblem</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="local2global.example.html">local2global.example</a></li>
<li class="toctree-l2"><a class="reference internal" href="local2global.test_local2global.html">local2global.test_local2global</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Index</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">local2global</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> »</li>
<li><a href="../reference.html">Reference</a> »</li>
<li><a href="local2global.utils.html">local2global.utils</a> »</li>
<li>local2global.utils.relative_orthogonal_transform</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/reference/local2global.utils.relative_orthogonal_transform.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="local2global-utils-relative-orthogonal-transform">
<h1>local2global.utils.relative_orthogonal_transform<a class="headerlink" href="#local2global-utils-relative-orthogonal-transform" title="Permalink to this headline">¶</a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="local2global.utils.relative_orthogonal_transform">
<span class="sig-name descname"><span class="pre">relative_orthogonal_transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coordinates1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coordinates2</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/local2global/utils.html#relative_orthogonal_transform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#local2global.utils.relative_orthogonal_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Find the best orthogonal transformation aligning two sets of coordinates for the same nodes</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>coordinates1</strong> – First set of coordinates (array-like)</p></li>
<li><p><strong>coordinates2</strong> – Second set of coordinates (array-like)</p></li>
</ul>
</dd>
</dl>
<p>Note that the two sets of coordinates need to have the same shape.</p>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="local2global.utils.relative_scale.html" class="btn btn-neutral float-right" title="local2global.utils.relative_scale" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="local2global.utils.procrustes_error.html" class="btn btn-neutral float-left" title="local2global.utils.procrustes_error" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2021, Lucas G. S. Jeub.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html> |