From 64106c4d3d4ddba8c7bc2af75376e6d3d3d75601 Mon Sep 17 00:00:00 2001 From: Date: Mon, 29 Jun 2015 20:16:15 +0000 Subject: Update documentation --- pkg_config/fn.find_library.html | 102 +++++++++++++++++++ pkg_config/fn.target_supported.html | 101 +++++++++++++++++++ pkg_config/index.html | 189 ++++++++++++++++++++++++++++++++++++ pkg_config/sidebar-items.js | 1 + pkg_config/struct.Config.html | 127 ++++++++++++++++++++++++ pkg_config/struct.Library.html | 117 ++++++++++++++++++++++ 6 files changed, 637 insertions(+) create mode 100644 pkg_config/fn.find_library.html create mode 100644 pkg_config/fn.target_supported.html create mode 100644 pkg_config/index.html create mode 100644 pkg_config/sidebar-items.js create mode 100644 pkg_config/struct.Config.html create mode 100644 pkg_config/struct.Library.html (limited to 'pkg_config') diff --git a/pkg_config/fn.find_library.html b/pkg_config/fn.find_library.html new file mode 100644 index 0000000..a8f3626 --- /dev/null +++ b/pkg_config/fn.find_library.html @@ -0,0 +1,102 @@ + + + + + + + + + + pkg_config::find_library - Rust + + + + + + + + + + + + + + + +
+

Function pkg_config::find_library + + [] + + [src]

+
pub fn find_library(name: &str) -> Result<Library, String>

Simple shortcut for using all default options for finding a library.

+
+ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/pkg_config/fn.target_supported.html b/pkg_config/fn.target_supported.html new file mode 100644 index 0000000..99c7a82 --- /dev/null +++ b/pkg_config/fn.target_supported.html @@ -0,0 +1,101 @@ + + + + + + + + + + pkg_config::target_supported - Rust + + + + + + + + + + + + + + + +
+

Function pkg_config::target_supported + + [] + + [src]

+
pub fn target_supported() -> bool
+ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/pkg_config/index.html b/pkg_config/index.html new file mode 100644 index 0000000..a339e49 --- /dev/null +++ b/pkg_config/index.html @@ -0,0 +1,189 @@ + + + + + + + + + + pkg_config - Rust + + + + + + + + + + + + + + + +
+

Crate pkg_config + + [] + + [src]

+

A build dependency for Cargo libraries to find system artifacts through the +pkg-config utility.

+ +

This library will shell out to pkg-config as part of build scripts and +probe the system to determine how to link to a specified library. The +Config structure serves as a method of configuring how pkg-config is +invoked in a builder style.

+ +

A number of environment variables are available to globally configure how +this crate will invoke pkg-config:

+ + + +

There are also a number of environment variables which can configure how a +library is linked to (dynamically vs statically). These variables control +whether the --static flag is passed. Note that this behavior can be +overridden by configuring explicitly on Config. The variables are checked +in the following order:

+ + + +

After running pkg-config all appropriate Cargo metadata will be printed on +stdout if the search was successful.

+ +

Example

+

Find the system library named foo.

+
+extern crate pkg_config;
+
+fn main() {
+    pkg_config::find_library("foo").unwrap();
+}
+
+ +

Configure how library foo is linked to.

+
+extern crate pkg_config;
+
+fn main() {
+    pkg_config::Config::new().statik(true).find("foo").unwrap();
+}
+
+

Structs

+ + + + + + + + + + +
Config + +
Library + +

Functions

+ + + + + + + + + + +
find_library +

Simple shortcut for using all default options for finding a library.

+ +
target_supported + +
+ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/pkg_config/sidebar-items.js b/pkg_config/sidebar-items.js new file mode 100644 index 0000000..996d381 --- /dev/null +++ b/pkg_config/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["find_library","Simple shortcut for using all default options for finding a library."],["target_supported",""]],"struct":[["Config",""],["Library",""]]}); \ No newline at end of file diff --git a/pkg_config/struct.Config.html b/pkg_config/struct.Config.html new file mode 100644 index 0000000..ff49efa --- /dev/null +++ b/pkg_config/struct.Config.html @@ -0,0 +1,127 @@ + + + + + + + + + + pkg_config::Config - Rust + + + + + + + + + + + + + + + +
+

Struct pkg_config::Config + + [] + + [src]

+
pub struct Config {
+    // some fields omitted
+}

Methods

impl Config

fn new() -> Config

+

Creates a new set of configuration options which are all initially set +to "blank".

+

fn statik(&mut self, statik: bool) -> &mut Config

+

Indicate whether the --static flag should be passed.

+ +

This will override the inference from environment variables described in +the crate documentation.

+

fn atleast_version(&mut self, vers: &str) -> &mut Config

+

Indicate that the library must be at least version vers.

+

fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Config

+

Add an argument to pass to pkg-config.

+ +

It's placed after all of the arguments generated by this library.

+

fn find(&self, name: &str) -> Result<Library, String>

+

Run pkg-config to find the library name.

+ +

This will use all configuration previously set to specify how +pkg-config is run.

+

fn get_variable(package: &str, variable: &str) -> Result<String, String>

+

Run pkg-config to get the value of a variable from a package using +--variable.

+

Trait Implementations

Derived Implementations

impl Clone for Config

fn clone(&self) -> Config

+

fn clone_from(&mut self, source: &Self)

+
+ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/pkg_config/struct.Library.html b/pkg_config/struct.Library.html new file mode 100644 index 0000000..92d7bc2 --- /dev/null +++ b/pkg_config/struct.Library.html @@ -0,0 +1,117 @@ + + + + + + + + + + pkg_config::Library - Rust + + + + + + + + + + + + + + + +
+

Struct pkg_config::Library + + [] + + [src]

+
pub struct Library {
+    pub libs: Vec<String>,
+    pub link_paths: Vec<PathBuf>,
+    pub frameworks: Vec<String>,
+    pub framework_paths: Vec<PathBuf>,
+    pub include_paths: Vec<PathBuf>,
+    pub version: String,
+    // some fields omitted
+}

Fields

+ + + + + + +
libs
frameworks
framework_paths
include_paths
version

Trait Implementations

Derived Implementations

impl Debug for Library

fn fmt(&self, __arg_0: &mut Formatter) -> Result

+
+ + + + + + + + + + + + + + + \ No newline at end of file -- cgit v1.2.3