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

FreeBSD Manual Pages

  
 
  

home | help
VMOD_STR(3)		   Library Functions Manual		   VMOD_STR(3)

NAME
       vmod_str	- Str VMOD

SYNOPSIS
	  import str [as name] [from "path"]

	  INT count(STRING s)

	  BOOL startswith(STRING s1, STRING s2)

	  BOOL endswith(STRING s1, STRING s2)

	  BOOL contains(STRING s1, STRING s2)

	  STRING take(STRING s,	INT n, INT offset)

	  STRING reverse(STRING	s)

	  STRING split(STRING S, INT n,	STRING sep)

	  BOOL token_intersect(STRING str1, STRING str2, [STRING separators])

DESCRIPTION
   INT count(STRING s)
       Returns the number of ascii characters in S, or -1 if S is null.

   BOOL	startswith(STRING s1, STRING s2)
       Returns true if S1 starts with S2.

   BOOL	endswith(STRING	s1, STRING s2)
       Returns true if S1 ends with S2.

   BOOL	contains(STRING	s1, STRING s2)
       Returns true if S1 contains S2.

   STRING take(STRING s, INT n,	INT offset=0)
       Returns	a  string  composed  of	 the  N	first characters of S. If S is
       shorter than N character, the return string is truncated. If S is NULL,
       NULL is returned.

       A negative offset means "from the end of	the string" and	a  negative  n
       means "left of the offset".

   STRING reverse(STRING s)
       Reverse s.

   STRING split(STRING S, INT n, STRING	sep=" t")
       Split  s	and return the n-th token. Characters in sep are separators. A
       negative	n indicate "from the end of the	string".

   BOOL	token_intersect(STRING str1, STRING str2, [STRING separators])
	  BOOL token_intersect(
	     STRING str1,
	     STRING str2,
	     [STRING separators]
	  )

       Checks if the set tokens	in one string intersects the set of tokens  in
       the  other  string. In other words, it returns true if there is a token
       which exists in both strings.

       If the separators argument is not supplied, the space and comma charac-
       ters are	the separators.	Empty tokens are ignored in both strings.

COPYRIGHT
	  Copyright (c)	2016 Guillaume Quintard

	  Author: Guillaume Quintard <guillaume.quintard@gmail.com>

	  (vmodtool requires this format.)

								   VMOD_STR(3)

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

home | help