Commit 7faa4316 authored by Nils Goroll's avatar Nils Goroll

auto-generated docs update

parent fe2da4d4
......@@ -6,26 +6,17 @@
.. role:: ref(emphasis)
.. _vmod_selector(3):
=============
vmod_selector
VMOD selector
=============
---------------------------------------------------------------------------------------
Varnish Module for matching strings associated with backends, regexen and other strings
---------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------
Varnish Module for matching strings associated with backends , regexen and other strings
----------------------------------------------------------------------------------------
:Manual section: 3
.. _VMOD re2: https://code.uplex.de/uplex-varnish/libvmod-re2
SYNOPSIS
========
......@@ -314,11 +305,10 @@ or the longest match, and so on::
# bar_backend for /foo/bar/quux
# foo_backend for /foo/quux
.. _vmod_selector.set:
.. _obj_set:
new xset = set(BOOL case_sensitive=1)
-------------------------------------
new xset = selector.set(BOOL case_sensitive=1)
----------------------------------------------
Create a set object. When ``case_sensitive`` is ``false``, matches
using the ``.match()`` and ``.hasprefix()`` methods are
......@@ -335,10 +325,10 @@ Example::
# ...
}
.. _func_set.add:
.. _vmod_selector.set.add:
set.add(...)
------------
VOID xset.add(STRING, STRING string, STRING regex, BACKEND backend)
-------------------------------------------------------------------
::
......@@ -384,8 +374,7 @@ Example::
regex="^/quux/([^/]+)/");
}
.. _func_set.create_stats:
.. _vmod_selector.set.create_stats:
VOID xset.create_stats()
------------------------
......@@ -417,8 +406,7 @@ Example::
myset.create_stats();
}
.. _func_set.match:
.. _vmod_selector.set.match:
BOOL xset.match(STRING)
-----------------------
......@@ -442,8 +430,7 @@ Example::
call do_on_match;
}
.. _func_set.hasprefix:
.. _vmod_selector.set.hasprefix:
BOOL xset.hasprefix(STRING)
---------------------------
......@@ -461,8 +448,7 @@ Example::
call do_if_prefix_matched;
}
.. _func_set.nmatches:
.. _vmod_selector.set.nmatches:
INT xset.nmatches()
-------------------
......@@ -495,8 +481,7 @@ Example::
set bereq.backend = myset.backend(select=UNIQUE);
}
.. _func_set.matched:
.. _vmod_selector.set.matched:
BOOL xset.matched(INT)
----------------------
......@@ -526,8 +511,7 @@ Example::
}
}
.. _func_set.which:
.. _vmod_selector.set.which:
INT xset.which(ENUM select)
---------------------------
......@@ -567,8 +551,7 @@ Example::
}
}
.. _func_set.element:
.. _vmod_selector.set.element:
STRING xset.element(INT n, ENUM select)
---------------------------------------
......@@ -609,8 +592,7 @@ Example::
set resp.http.Location = "http://other.com" + myset.element();
}
.. _func_set.backend:
.. _vmod_selector.set.backend:
BACKEND xset.backend(INT n, ENUM select)
----------------------------------------
......@@ -642,8 +624,7 @@ Example::
set bereq.backend = myset.backend(select=LONGEST);
}
.. _func_set.string:
.. _vmod_selector.set.string:
STRING xset.string(INT n, ENUM select)
--------------------------------------
......@@ -672,8 +653,7 @@ Example::
set req.url = myset.string();
}
.. _func_set.re_match:
.. _vmod_selector.set.re_match:
BOOL xset.re_match(STRING subject, INT n, ENUM select)
------------------------------------------------------
......@@ -721,11 +701,10 @@ Example::
}
}
.. _vmod_selector.set.sub:
.. _func_set.sub:
set.sub(...)
------------
STRING xset.sub(STRING str, STRING sub, BOOL all, INT n, ENUM select)
---------------------------------------------------------------------
::
......@@ -782,19 +761,14 @@ Example::
# /foo/bar/1/2/* is rewritten as /foo/bar/2/1/*
# /foo/bar/baz/1/2/* is rewritten as /foo/bar/baz/2/1/*
.. _func_set.debug:
.. _vmod_selector.set.debug:
STRING xset.debug()
-------------------
Intentionally not documented.
.. _func_version:
.. _vmod_selector.version:
STRING version()
----------------
......@@ -937,7 +911,6 @@ SEE ALSO
* VMOD source repository: https://code.uplex.de/uplex-varnish/libvmod-selector
* `VMOD re2`_: https://code.uplex.de/uplex-varnish/libvmod-re2
COPYRIGHT
=========
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment