Files
phy/x11rb/resource_manager/fn.new_from_default.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

21 lines
4.7 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Create a new X11 resource database from the default locations."><title>new_from_default in x11rb::resource_manager - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="x11rb" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../x11rb/index.html">x11rb</a><span class="version">0.13.1</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In x11rb::<wbr>resource_<wbr>manager</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">x11rb</a>::<wbr><a href="index.html">resource_manager</a></span><h1>Function <span class="fn">new_from_default</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/x11rb/resource_manager/mod.rs.html#64-69">Source</a> </span></div><pre class="rust item-decl"><code>pub fn new_from_default(conn: &amp;impl <a class="trait" href="../connection/trait.Connection.html" title="trait x11rb::connection::Connection">Connection</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.Database.html" title="struct x11rb::resource_manager::Database">Database</a>, <a class="enum" href="../errors/enum.ReplyError.html" title="enum x11rb::errors::ReplyError">ReplyError</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Create a new X11 resource database from the default locations.</p>
<p>The default location is a combination of two places. First, the following places are
searched for data:</p>
<ul>
<li>The <code>RESOURCE_MANAGER</code> property of the first screens root window (See
<a href="fn.new_from_resource_manager.html" title="fn x11rb::resource_manager::new_from_resource_manager"><code>new_from_resource_manager</code></a>).</li>
<li>If not found, the file <code>$HOME/.Xresources</code> is loaded.</li>
<li>If not found, the file <code>$HOME/.Xdefaults</code> is loaded.</li>
</ul>
<p>The result of the above search of the above search is combined with:</p>
<ul>
<li>The contents of the file <code>$XENVIRONMENT</code>, if this environment variable is set.</li>
<li>Otherwise, the contents of <code>$HOME/.Xdefaults-[hostname]</code>.</li>
</ul>
<p>This function only returns an error if communication with the X11 server fails. All other
errors are ignored. It might be that an empty database is returned.</p>
<p>The behaviour of this function is mostly equivalent to Xlibs <code>XGetDefault()</code>. The
exception is that <code>XGetDefault()</code> does not load <code>$HOME/.Xresources</code>.</p>
<p>The behaviour of this function is equivalent to xcb-util-xrms
<code>xcb_xrm_database_from_default()</code>.</p>
</div></details></section></div></main></body></html>