Show / Hide Table of Contents

Class Wordlist

Represents a file as a source of input data that needs to be tested against a Config by the Runner.

Inheritance
System.Object
Wordlist
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: RuriLib.Models
Assembly: RuriLib.dll
Syntax
public class Wordlist

Constructors

| Improve this Doc View Source

Wordlist()

Needed for NoSQL deserialization.

Declaration
public Wordlist()
| Improve this Doc View Source

Wordlist(String, String, String, String, Boolean)

Creates an instance of a Wordlist.

Declaration
public Wordlist(string name, string path, string type, string purpose, bool countLines = true)
Parameters
Type Name Description
System.String name

The name of the Wordlist

System.String path

The path to the file on disk

System.String type

The WordlistType as a string

System.String purpose

The purpose of the Wordlist

System.Boolean countLines

Whether to enumerate the total number of data lines in the Wordlist

Properties

| Improve this Doc View Source

Id

Needed for NoSQL storage.

Declaration
public Guid Id { get; set; }
Property Value
Type Description
System.Guid
| Improve this Doc View Source

Name

The name of the Wordlist.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Path

The path where the file is stored on disk.

Declaration
public string Path { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Purpose

The purpose for which the Wordlist should be used.

Declaration
public string Purpose { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Total

The total number of data lines of the file.

Declaration
public int Total { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Type

The WordlistType as a string (since the WordlistTypes in the Environment file are editable).

Declaration
public string Type { get; set; }
Property Value
Type Description
System.String
  • Improve this Doc
  • View Source
Back to top Generated by DocFX