|
1 | | -<!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="Copies a configuration file to the user’s home directory, ensuring idempotent operation."><title>user_config_setup in gnulinwiz::functionality::configs - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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-916cea96.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="gnulinwiz" data-themes="" data-resource-suffix="" data-rustdoc-version="1.87.0 (17067e9ac 2025-05-09)" data-channel="1.87.0" data-search-js="search-e7298875.js" data-settings-js="settings-d72f25bb.js" ><script src="../../../static.files/storage-82c7156e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-fb8c74a8.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="../../../gnulinwiz/index.html">gnulinwiz</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">user_<wbr>config_<wbr>setup</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#arguments" title="Arguments">Arguments</a></li><li><a href="#returns" title="Returns">Returns</a></li><li><a href="#errors" title="Errors">Errors</a></li><li><a href="#example" title="Example">Example</a></li><li><a href="#see-also" title="See Also">See Also</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In gnulinwiz::<wbr>functionality::<wbr>configs</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"><div class="rustdoc-breadcrumbs"><a href="../../index.html">gnulinwiz</a>::<wbr><a href="../index.html">functionality</a>::<wbr><a href="index.html">configs</a></div><h1>Function <span class="fn">user_config_setup</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/gnulinwiz/functionality/configs.rs.html#57-91">Source</a> </span></div><pre class="rust item-decl"><code>pub fn user_config_setup( |
| 1 | +<!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="Copies a configuration file to the user’s home directory, ensuring idempotent operation."><title>user_config_setup in gnulinwiz::functionality::configs - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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-916cea96.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="gnulinwiz" data-themes="" data-resource-suffix="" data-rustdoc-version="1.87.0 (17067e9ac 2025-05-09)" data-channel="1.87.0" data-search-js="search-e7298875.js" data-settings-js="settings-d72f25bb.js" ><script src="../../../static.files/storage-82c7156e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-fb8c74a8.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="../../../gnulinwiz/index.html">gnulinwiz</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">user_<wbr>config_<wbr>setup</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#arguments" title="Arguments">Arguments</a></li><li><a href="#returns" title="Returns">Returns</a></li><li><a href="#errors" title="Errors">Errors</a></li><li><a href="#example" title="Example">Example</a></li><li><a href="#see-also" title="See Also">See Also</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In gnulinwiz::<wbr>functionality::<wbr>configs</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"><div class="rustdoc-breadcrumbs"><a href="../../index.html">gnulinwiz</a>::<wbr><a href="../index.html">functionality</a>::<wbr><a href="index.html">configs</a></div><h1>Function <span class="fn">user_config_setup</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/gnulinwiz/functionality/configs.rs.html#59-93">Source</a> </span></div><pre class="rust item-decl"><code>pub fn user_config_setup( |
2 | 2 | config_path: &<a class="primitive" href="https://doc.rust-lang.org/1.87.0/std/primitive.str.html">str</a>, |
3 | 3 | home_dir: &<a class="primitive" href="https://doc.rust-lang.org/1.87.0/std/primitive.str.html">str</a>, |
4 | 4 | cfg_name: &<a class="primitive" href="https://doc.rust-lang.org/1.87.0/std/primitive.str.html">str</a>, |
@@ -26,9 +26,11 @@ <h2 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h2> |
26 | 26 | <li>The file copy operation fails due to permissions or other I/O errors.</li> |
27 | 27 | </ul> |
28 | 28 | <h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2> |
29 | | -<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gnulinwiz::functionality::configs::user_config_setup; |
| 29 | +<div class="example-wrap should_panic"><a href="#" class="tooltip" title="This example panics">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="comment">// This example requires a valid ../configs/.zshrc file and write permissions. |
| 30 | +// For actual testing, use integration tests with a mocked file system. |
| 31 | +</span><span class="kw">use </span>gnulinwiz::functionality::configs::user_config_setup; |
30 | 32 | <span class="kw">let </span>result = user_config_setup(<span class="string">"../configs/.zshrc"</span>, <span class="string">"/home/user"</span>, <span class="string">"zsh"</span>); |
31 | | -<span class="macro">assert_eq!</span>(result, <span class="number">0</span>); <span class="comment">// Configuration copied or skipped successfully</span></code></pre></div> |
| 33 | +<span class="macro">assert_eq!</span>(result, <span class="number">0</span>); <span class="comment">// Success if files exist and no overwrite prompt</span></code></pre></div> |
32 | 34 | <h2 id="see-also"><a class="doc-anchor" href="#see-also">§</a>See Also</h2> |
33 | 35 | <ul> |
34 | 36 | <li><code>prog_fun::read_input</code>: Used to prompt the user for overwrite confirmation.</li> |
|
0 commit comments