Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
nbdkit_parse_size(3)		     NBDKIT		    nbdkit_parse_size(3)

NAME
     nbdkit_parse_size - parse human-readable size strings for nbdkit

SYNOPSIS
      #include <nbdkit-plugin.h>

      int64_t nbdkit_parse_size (const char *str);

DESCRIPTION
     Use the "nbdkit_parse_size" utility function to parse human-readable size
     strings such as "100M" into the size in bytes.

     The "str" parameter is a string in a number of common formats.

RETURN VALUE
     The function returns the size in bytes.

     If there is an error it calls nbdkit_error(3) and returns -1.

LANGUAGE BINDINGS
     In nbdkit-ocaml-plugin(3):

      NBDKit.parse_size : string -> int64

     In nbdkit-python-plugin(3):

      import nbdkit
      size = nbdkit.parse_size(str)

     In nbdkit-rust-plugin(3):

      use nbdkit::*;
      pub fn parse_size(s: &str) -> Result<i64>

     In nbdkit-sh-plugin(3), "nbdkit_parse_size" is called implicitly to parse
     the output of "get_size" and other methods.

HISTORY
     "nbdkit_parse_size" was present in nbdkit 0.1.0.

SEE ALSO
     nbdkit(1), nbdkit_parse_bool(3), nbdkit_parse_delay(3), nbd-
     kit_parse_int(3), nbdkit_parse_probability(3), nbdkit-plugin(3), nbd-
     kit-filter(3).

AUTHORS
     Richard W.M. Jones

COPYRIGHT
     Copyright Red Hat

LICENSE
     Redistribution and use in source and binary forms, with or without modifi-
     cation, are permitted provided that the following conditions are met:

     *	 Redistributions of source code must retain the above copyright notice,
	 this list of conditions and the following disclaimer.

     *	 Redistributions in binary form must reproduce the above copyright no-
	 tice, this list of conditions and the following disclaimer in the docu-
	 mentation and/or other materials provided with the distribution.

     *	 Neither the name of Red Hat nor the names of its contributors may be
	 used to endorse or promote products derived from this software without
	 specific prior written permission.

     THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY EX-
     PRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DIS-
     CLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE LIABLE FOR ANY DI-
     RECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SER-
     VICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABIL-
     ITY, 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 DAM-
     AGE.

nbdkit-1.46.2			   2026-08-30		    nbdkit_parse_size(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=nbdkit_parse_size&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help