...
Tawesoft Logo

Source file src/tawesoft.co.uk/go/router/doc.go

Documentation: src/tawesoft.co.uk/go/router/doc.go

     1  // tawesoft.co.uk/go/router
     2  // 
     3  // Copyright © 2020 Tawesoft Ltd <open-source@tawesoft.co.uk>
     4  // Copyright © 2020 Ben Golightly <ben@tawesoft.co.uk>
     5  // 
     6  // Permission is hereby granted, free of charge, to any person obtaining a copy
     7  // of this software and associated documentation files (the "Software"), to deal
     8  // in the Software without restriction,  including without limitation the rights
     9  // to use,  copy, modify,  merge,  publish, distribute, sublicense,  and/or sell
    10  // copies  of  the  Software,  and  to  permit persons  to whom  the Software is
    11  // furnished to do so, subject to the following conditions:
    12  // 
    13  // The above copyright notice and this permission notice shall be included in all
    14  // copies or substantial portions of the Software.
    15  // 
    16  // THE SOFTWARE IS PROVIDED  "AS IS",  WITHOUT WARRANTY OF ANY KIND,  EXPRESS OR
    17  // IMPLIED,  INCLUDING  BUT  NOT LIMITED TO THE WARRANTIES  OF  MERCHANTABILITY,
    18  // FITNESS FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
    19  // AUTHORS  OR COPYRIGHT HOLDERS  BE LIABLE  FOR ANY  CLAIM,  DAMAGES  OR  OTHER
    20  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    21  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    22  // SOFTWARE.
    23  
    24  // Package router is a general purpose router of methods (e.g. HTTP "GET") and
    25  // paths (e.g. "/user/123/profile") to some value e.g. a controller.
    26  // 
    27  // Supports named routes, route parameters, constructing a path from a route,
    28  // pattern submatches, etc.
    29  // 
    30  // Although built with HTTP routing in mind, this is a general purpose
    31  // implementation that can route to any type of value - it is not limited to
    32  // HTTP handlers.
    33  // 
    34  // Examples
    35  // 
    36  // Demonstrates simple HTTP routing and named routes with a server at
    37  // localhost:8080
    38  //
    39  // https://www.tawesoft.co.uk/go/doc/router/examples/httprouting/
    40  //
    41  //
    42  // Package Information
    43  //
    44  // License: MIT (see LICENSE.txt)
    45  //
    46  // Stable: candidate
    47  //
    48  // For more information, documentation, source code, examples, support, links,
    49  // etc. please see https://www.tawesoft.co.uk/go and 
    50  // https://www.tawesoft.co.uk/go/router
    51  package router // import "tawesoft.co.uk/go/router"
    52  
    53  // Code generated by internal. DO NOT EDIT.
    54  // Instead, edit DESC.txt and run mkdocs.sh.

View as plain text