mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 16:38:24 +00:00
29 lines
11 KiB
HTML
29 lines
11 KiB
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="Bindings to libgit2’s git_libgit2_opts function."><title>git2::opts - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-5bc39a1768837dd0.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="git2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.77.1 (7cf61ebde 2024-03-27)" data-channel="1.77.1" data-search-js="search-dd67cee4cfa65049.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-48f368f3872407c8.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[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="../../git2/index.html">git2</a><span class="version">0.18.3</span></h2></div><h2 class="location"><a href="#">Module opts</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate git2</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../git2/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">git2</a>::<wbr><a class="mod" href="#">opts</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/git2/opts.rs.html#1-373">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Bindings to libgit2’s git_libgit2_opts function.</p>
|
||
</div></details><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.enable_caching.html" title="fn git2::opts::enable_caching">enable_caching</a></div><div class="desc docblock-short">Controls whether or not libgit2 will cache loaded objects. Enabled by
|
||
default, but disabling this can improve performance and memory usage if
|
||
loading a large number of objects that will not be referenced again.
|
||
Disabling this will cause repository objects to clear their caches when next
|
||
accessed.</div></li><li><div class="item-name"><a class="fn" href="fn.get_extensions.html" title="fn git2::opts::get_extensions">get_extensions</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns the list of git extensions that are supported. This is the list of
|
||
built-in extensions supported by libgit2 and custom extensions that have
|
||
been added with <a href="fn.set_extensions.html" title="fn git2::opts::set_extensions"><code>set_extensions</code></a>. Extensions that have been negated will
|
||
not be returned.</div></li><li><div class="item-name"><a class="fn" href="fn.get_mwindow_file_limit.html" title="fn git2::opts::get_mwindow_file_limit">get_mwindow_file_limit</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Get the maximum number of files that will be mapped at any time by the
|
||
library.</div></li><li><div class="item-name"><a class="fn" href="fn.get_mwindow_mapped_limit.html" title="fn git2::opts::get_mwindow_mapped_limit">get_mwindow_mapped_limit</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Get the maximum memory that will be mapped in total by the library</div></li><li><div class="item-name"><a class="fn" href="fn.get_mwindow_size.html" title="fn git2::opts::get_mwindow_size">get_mwindow_size</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Get the maximum mmap window size</div></li><li><div class="item-name"><a class="fn" href="fn.get_search_path.html" title="fn git2::opts::get_search_path">get_search_path</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Get the search path for a given level of config data.</div></li><li><div class="item-name"><a class="fn" href="fn.reset_search_path.html" title="fn git2::opts::reset_search_path">reset_search_path</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Reset the search path for a given level of config data to the default
|
||
(generally based on environment variables).</div></li><li><div class="item-name"><a class="fn" href="fn.set_extensions.html" title="fn git2::opts::set_extensions">set_extensions</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Set that the given git extensions are supported by the caller. Extensions
|
||
supported by libgit2 may be negated by prefixing them with a <code>!</code>.
|
||
For example: setting extensions to <code>[ "!noop", "newext" ]</code> indicates that
|
||
the caller does not want to support repositories with the <code>noop</code> extension
|
||
but does want to support repositories with the <code>newext</code> extension.</div></li><li><div class="item-name"><a class="fn" href="fn.set_mwindow_file_limit.html" title="fn git2::opts::set_mwindow_file_limit">set_mwindow_file_limit</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Set the maximum number of files that can be mapped at any time
|
||
by the library. The default (0) is unlimited.</div></li><li><div class="item-name"><a class="fn" href="fn.set_mwindow_mapped_limit.html" title="fn git2::opts::set_mwindow_mapped_limit">set_mwindow_mapped_limit</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Set the maximum amount of memory that can be mapped at any time
|
||
by the library.</div></li><li><div class="item-name"><a class="fn" href="fn.set_mwindow_size.html" title="fn git2::opts::set_mwindow_size">set_mwindow_size</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Set the maximum mmap window size</div></li><li><div class="item-name"><a class="fn" href="fn.set_search_path.html" title="fn git2::opts::set_search_path">set_search_path</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Set the search path for a level of config data. The search path applied to
|
||
shared attributes and ignore files, too.</div></li><li><div class="item-name"><a class="fn" href="fn.set_ssl_cert_dir.html" title="fn git2::opts::set_ssl_cert_dir">set_ssl_cert_dir</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Set the SSL certificate-authority location to <code>path</code>. <code>path</code> is the location
|
||
of a directory holding several certificates, one per file.</div></li><li><div class="item-name"><a class="fn" href="fn.set_ssl_cert_file.html" title="fn git2::opts::set_ssl_cert_file">set_ssl_cert_file</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Set the SSL certificate-authority location to <code>file</code>. <code>file</code> is the location
|
||
of a file containing several certificates concatenated together.</div></li><li><div class="item-name"><a class="fn" href="fn.set_verify_owner_validation.html" title="fn git2::opts::set_verify_owner_validation">set_verify_owner_validation</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Set whether or not to verify ownership before performing a repository.
|
||
Enabled by default, but disabling this can lead to code execution vulnerabilities.</div></li><li><div class="item-name"><a class="fn" href="fn.strict_hash_verification.html" title="fn git2::opts::strict_hash_verification">strict_hash_verification</a></div><div class="desc docblock-short">Controls whether or not libgit2 will verify that objects loaded have the
|
||
expected hash. Enabled by default, but disabling this can significantly
|
||
improve performance, at the cost of relying on repository integrity
|
||
without checking it.</div></li><li><div class="item-name"><a class="fn" href="fn.strict_object_creation.html" title="fn git2::opts::strict_object_creation">strict_object_creation</a></div><div class="desc docblock-short">Controls whether or not libgit2 will verify when writing an object that all
|
||
objects it references are valid. Enabled by default, but disabling this can
|
||
significantly improve performance, at the cost of potentially allowing the
|
||
creation of objects that reference invalid objects (due to programming
|
||
error or repository corruption).</div></li></ul></section></div></main></body></html> |