xunit.assert.xml 94 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>xunit.assert</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Xunit.Assert">
  8. <summary>
  9. Contains various static methods that are used to verify that conditions are met during the
  10. process of running tests.
  11. </summary>
  12. </member>
  13. <member name="M:Xunit.Assert.#ctor">
  14. <summary>
  15. Initializes a new instance of the <see cref="T:Xunit.Assert"/> class.
  16. </summary>
  17. </member>
  18. <member name="M:Xunit.Assert.Equals(System.Object,System.Object)">
  19. <summary>Do not call this method.</summary>
  20. </member>
  21. <member name="M:Xunit.Assert.ReferenceEquals(System.Object,System.Object)">
  22. <summary>Do not call this method.</summary>
  23. </member>
  24. <member name="M:Xunit.Assert.False(System.Boolean)">
  25. <summary>
  26. Verifies that the condition is false.
  27. </summary>
  28. <param name="condition">The condition to be tested</param>
  29. <exception cref="T:Xunit.Sdk.FalseException">Thrown if the condition is not false</exception>
  30. </member>
  31. <member name="M:Xunit.Assert.False(System.Nullable{System.Boolean})">
  32. <summary>
  33. Verifies that the condition is false.
  34. </summary>
  35. <param name="condition">The condition to be tested</param>
  36. <exception cref="T:Xunit.Sdk.FalseException">Thrown if the condition is not false</exception>
  37. </member>
  38. <member name="M:Xunit.Assert.False(System.Boolean,System.String)">
  39. <summary>
  40. Verifies that the condition is false.
  41. </summary>
  42. <param name="condition">The condition to be tested</param>
  43. <param name="userMessage">The message to show when the condition is not false</param>
  44. <exception cref="T:Xunit.Sdk.FalseException">Thrown if the condition is not false</exception>
  45. </member>
  46. <member name="M:Xunit.Assert.False(System.Nullable{System.Boolean},System.String)">
  47. <summary>
  48. Verifies that the condition is false.
  49. </summary>
  50. <param name="condition">The condition to be tested</param>
  51. <param name="userMessage">The message to show when the condition is not false</param>
  52. <exception cref="T:Xunit.Sdk.FalseException">Thrown if the condition is not false</exception>
  53. </member>
  54. <member name="M:Xunit.Assert.True(System.Boolean)">
  55. <summary>
  56. Verifies that an expression is true.
  57. </summary>
  58. <param name="condition">The condition to be inspected</param>
  59. <exception cref="T:Xunit.Sdk.TrueException">Thrown when the condition is false</exception>
  60. </member>
  61. <member name="M:Xunit.Assert.True(System.Nullable{System.Boolean})">
  62. <summary>
  63. Verifies that an expression is true.
  64. </summary>
  65. <param name="condition">The condition to be inspected</param>
  66. <exception cref="T:Xunit.Sdk.TrueException">Thrown when the condition is false</exception>
  67. </member>
  68. <member name="M:Xunit.Assert.True(System.Boolean,System.String)">
  69. <summary>
  70. Verifies that an expression is true.
  71. </summary>
  72. <param name="condition">The condition to be inspected</param>
  73. <param name="userMessage">The message to be shown when the condition is false</param>
  74. <exception cref="T:Xunit.Sdk.TrueException">Thrown when the condition is false</exception>
  75. </member>
  76. <member name="M:Xunit.Assert.True(System.Nullable{System.Boolean},System.String)">
  77. <summary>
  78. Verifies that an expression is true.
  79. </summary>
  80. <param name="condition">The condition to be inspected</param>
  81. <param name="userMessage">The message to be shown when the condition is false</param>
  82. <exception cref="T:Xunit.Sdk.TrueException">Thrown when the condition is false</exception>
  83. </member>
  84. <member name="M:Xunit.Assert.All``1(System.Collections.Generic.IEnumerable{``0},System.Action{``0})">
  85. <summary>
  86. Verifies that all items in the collection pass when executed against
  87. action.
  88. </summary>
  89. <typeparam name="T">The type of the object to be verified</typeparam>
  90. <param name="collection">The collection</param>
  91. <param name="action">The action to test each item against</param>
  92. <exception cref="T:Xunit.Sdk.AllException">Thrown when the collection contains at least one non-matching element</exception>
  93. </member>
  94. <member name="M:Xunit.Assert.Collection``1(System.Collections.Generic.IEnumerable{``0},System.Action{``0}[])">
  95. <summary>
  96. Verifies that a collection contains exactly a given number of elements, which meet
  97. the criteria provided by the element inspectors.
  98. </summary>
  99. <typeparam name="T">The type of the object to be verified</typeparam>
  100. <param name="collection">The collection to be inspected</param>
  101. <param name="elementInspectors">The element inspectors, which inspect each element in turn. The
  102. total number of element inspectors must exactly match the number of elements in the collection.</param>
  103. </member>
  104. <member name="M:Xunit.Assert.Contains``1(``0,System.Collections.Generic.IEnumerable{``0})">
  105. <summary>
  106. Verifies that a collection contains a given object.
  107. </summary>
  108. <typeparam name="T">The type of the object to be verified</typeparam>
  109. <param name="expected">The object expected to be in the collection</param>
  110. <param name="collection">The collection to be inspected</param>
  111. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the object is not present in the collection</exception>
  112. </member>
  113. <member name="M:Xunit.Assert.Contains``1(``0,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
  114. <summary>
  115. Verifies that a collection contains a given object, using an equality comparer.
  116. </summary>
  117. <typeparam name="T">The type of the object to be verified</typeparam>
  118. <param name="expected">The object expected to be in the collection</param>
  119. <param name="collection">The collection to be inspected</param>
  120. <param name="comparer">The comparer used to equate objects in the collection with the expected object</param>
  121. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the object is not present in the collection</exception>
  122. </member>
  123. <member name="M:Xunit.Assert.Contains``1(System.Collections.Generic.IEnumerable{``0},System.Predicate{``0})">
  124. <summary>
  125. Verifies that a collection contains a given object.
  126. </summary>
  127. <typeparam name="T">The type of the object to be verified</typeparam>
  128. <param name="collection">The collection to be inspected</param>
  129. <param name="filter">The filter used to find the item you're ensuring the collection contains</param>
  130. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the object is not present in the collection</exception>
  131. </member>
  132. <member name="M:Xunit.Assert.Contains``2(``0,System.Collections.Generic.IReadOnlyDictionary{``0,``1})">
  133. <summary>
  134. Verifies that a dictionary contains a given key.
  135. </summary>
  136. <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
  137. <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
  138. <param name="expected">The object expected to be in the collection.</param>
  139. <param name="collection">The collection to be inspected.</param>
  140. <returns>The value associated with <paramref name="expected"/>.</returns>
  141. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the object is not present in the collection</exception>
  142. </member>
  143. <member name="M:Xunit.Assert.Contains``2(``0,System.Collections.Generic.IDictionary{``0,``1})">
  144. <summary>
  145. Verifies that a dictionary contains a given key.
  146. </summary>
  147. <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
  148. <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
  149. <param name="expected">The object expected to be in the collection.</param>
  150. <param name="collection">The collection to be inspected.</param>
  151. <returns>The value associated with <paramref name="expected"/>.</returns>
  152. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the object is not present in the collection</exception>
  153. </member>
  154. <member name="M:Xunit.Assert.DoesNotContain``1(``0,System.Collections.Generic.IEnumerable{``0})">
  155. <summary>
  156. Verifies that a collection does not contain a given object.
  157. </summary>
  158. <typeparam name="T">The type of the object to be compared</typeparam>
  159. <param name="expected">The object that is expected not to be in the collection</param>
  160. <param name="collection">The collection to be inspected</param>
  161. <exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the object is present inside the container</exception>
  162. </member>
  163. <member name="M:Xunit.Assert.DoesNotContain``1(``0,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
  164. <summary>
  165. Verifies that a collection does not contain a given object, using an equality comparer.
  166. </summary>
  167. <typeparam name="T">The type of the object to be compared</typeparam>
  168. <param name="expected">The object that is expected not to be in the collection</param>
  169. <param name="collection">The collection to be inspected</param>
  170. <param name="comparer">The comparer used to equate objects in the collection with the expected object</param>
  171. <exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the object is present inside the container</exception>
  172. </member>
  173. <member name="M:Xunit.Assert.DoesNotContain``1(System.Collections.Generic.IEnumerable{``0},System.Predicate{``0})">
  174. <summary>
  175. Verifies that a collection does not contain a given object.
  176. </summary>
  177. <typeparam name="T">The type of the object to be compared</typeparam>
  178. <param name="collection">The collection to be inspected</param>
  179. <param name="filter">The filter used to find the item you're ensuring the collection does not contain</param>
  180. <exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the object is present inside the container</exception>
  181. </member>
  182. <member name="M:Xunit.Assert.DoesNotContain``2(``0,System.Collections.Generic.IReadOnlyDictionary{``0,``1})">
  183. <summary>
  184. Verifies that a dictionary does not contain a given key.
  185. </summary>
  186. <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
  187. <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
  188. <param name="expected">The object expected to be in the collection.</param>
  189. <param name="collection">The collection to be inspected.</param>
  190. <exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the object is present in the collection</exception>
  191. </member>
  192. <member name="M:Xunit.Assert.DoesNotContain``2(``0,System.Collections.Generic.IDictionary{``0,``1})">
  193. <summary>
  194. Verifies that a dictionary does not contain a given key.
  195. </summary>
  196. <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
  197. <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
  198. <param name="expected">The object expected to be in the collection.</param>
  199. <param name="collection">The collection to be inspected.</param>
  200. <exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the object is present in the collection</exception>
  201. </member>
  202. <member name="M:Xunit.Assert.Empty(System.Collections.IEnumerable)">
  203. <summary>
  204. Verifies that a collection is empty.
  205. </summary>
  206. <param name="collection">The collection to be inspected</param>
  207. <exception cref="T:System.ArgumentNullException">Thrown when the collection is null</exception>
  208. <exception cref="T:Xunit.Sdk.EmptyException">Thrown when the collection is not empty</exception>
  209. </member>
  210. <member name="M:Xunit.Assert.Equal``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0})">
  211. <summary>
  212. Verifies that two sequences are equivalent, using a default comparer.
  213. </summary>
  214. <typeparam name="T">The type of the objects to be compared</typeparam>
  215. <param name="expected">The expected value</param>
  216. <param name="actual">The value to be compared against</param>
  217. <exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
  218. </member>
  219. <member name="M:Xunit.Assert.Equal``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
  220. <summary>
  221. Verifies that two sequences are equivalent, using a custom equatable comparer.
  222. </summary>
  223. <typeparam name="T">The type of the objects to be compared</typeparam>
  224. <param name="expected">The expected value</param>
  225. <param name="actual">The value to be compared against</param>
  226. <param name="comparer">The comparer used to compare the two objects</param>
  227. <exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
  228. </member>
  229. <member name="M:Xunit.Assert.NotEmpty(System.Collections.IEnumerable)">
  230. <summary>
  231. Verifies that a collection is not empty.
  232. </summary>
  233. <param name="collection">The collection to be inspected</param>
  234. <exception cref="T:System.ArgumentNullException">Thrown when a null collection is passed</exception>
  235. <exception cref="T:Xunit.Sdk.NotEmptyException">Thrown when the collection is empty</exception>
  236. </member>
  237. <member name="M:Xunit.Assert.NotEqual``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0})">
  238. <summary>
  239. Verifies that two sequences are not equivalent, using a default comparer.
  240. </summary>
  241. <typeparam name="T">The type of the objects to be compared</typeparam>
  242. <param name="expected">The expected object</param>
  243. <param name="actual">The actual object</param>
  244. <exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
  245. </member>
  246. <member name="M:Xunit.Assert.NotEqual``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
  247. <summary>
  248. Verifies that two sequences are not equivalent, using a custom equality comparer.
  249. </summary>
  250. <typeparam name="T">The type of the objects to be compared</typeparam>
  251. <param name="expected">The expected object</param>
  252. <param name="actual">The actual object</param>
  253. <param name="comparer">The comparer used to compare the two objects</param>
  254. <exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
  255. </member>
  256. <member name="M:Xunit.Assert.Single(System.Collections.IEnumerable)">
  257. <summary>
  258. Verifies that the given collection contains only a single
  259. element of the given type.
  260. </summary>
  261. <param name="collection">The collection.</param>
  262. <returns>The single item in the collection.</returns>
  263. <exception cref="T:Xunit.Sdk.SingleException">Thrown when the collection does not contain
  264. exactly one element.</exception>
  265. </member>
  266. <member name="M:Xunit.Assert.Single(System.Collections.IEnumerable,System.Object)">
  267. <summary>
  268. Verifies that the given collection contains only a single
  269. element of the given value. The collection may or may not
  270. contain other values.
  271. </summary>
  272. <param name="collection">The collection.</param>
  273. <param name="expected">The value to find in the collection.</param>
  274. <returns>The single item in the collection.</returns>
  275. <exception cref="T:Xunit.Sdk.SingleException">Thrown when the collection does not contain
  276. exactly one element.</exception>
  277. </member>
  278. <member name="M:Xunit.Assert.Single``1(System.Collections.Generic.IEnumerable{``0})">
  279. <summary>
  280. Verifies that the given collection contains only a single
  281. element of the given type.
  282. </summary>
  283. <typeparam name="T">The collection type.</typeparam>
  284. <param name="collection">The collection.</param>
  285. <returns>The single item in the collection.</returns>
  286. <exception cref="T:Xunit.Sdk.SingleException">Thrown when the collection does not contain
  287. exactly one element.</exception>
  288. </member>
  289. <member name="M:Xunit.Assert.Single``1(System.Collections.Generic.IEnumerable{``0},System.Predicate{``0})">
  290. <summary>
  291. Verifies that the given collection contains only a single
  292. element of the given type which matches the given predicate. The
  293. collection may or may not contain other values which do not
  294. match the given predicate.
  295. </summary>
  296. <typeparam name="T">The collection type.</typeparam>
  297. <param name="collection">The collection.</param>
  298. <param name="predicate">The item matching predicate.</param>
  299. <returns>The single item in the filtered collection.</returns>
  300. <exception cref="T:Xunit.Sdk.SingleException">Thrown when the filtered collection does
  301. not contain exactly one element.</exception>
  302. </member>
  303. <member name="M:Xunit.Assert.Equal``1(``0,``0)">
  304. <summary>
  305. Verifies that two objects are equal, using a default comparer.
  306. </summary>
  307. <typeparam name="T">The type of the objects to be compared</typeparam>
  308. <param name="expected">The expected value</param>
  309. <param name="actual">The value to be compared against</param>
  310. <exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
  311. </member>
  312. <member name="M:Xunit.Assert.Equal``1(``0,``0,System.Collections.Generic.IEqualityComparer{``0})">
  313. <summary>
  314. Verifies that two objects are equal, using a custom equatable comparer.
  315. </summary>
  316. <typeparam name="T">The type of the objects to be compared</typeparam>
  317. <param name="expected">The expected value</param>
  318. <param name="actual">The value to be compared against</param>
  319. <param name="comparer">The comparer used to compare the two objects</param>
  320. <exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
  321. </member>
  322. <member name="M:Xunit.Assert.Equal(System.Double,System.Double,System.Int32)">
  323. <summary>
  324. Verifies that two <see cref="T:System.Double"/> values are equal, within the number of decimal
  325. places given by <paramref name="precision"/>. The values are rounded before comparison.
  326. </summary>
  327. <param name="expected">The expected value</param>
  328. <param name="actual">The value to be compared against</param>
  329. <param name="precision">The number of decimal places (valid values: 0-15)</param>
  330. <exception cref="T:Xunit.Sdk.EqualException">Thrown when the values are not equal</exception>
  331. </member>
  332. <member name="M:Xunit.Assert.Equal(System.Decimal,System.Decimal,System.Int32)">
  333. <summary>
  334. Verifies that two <see cref="T:System.Decimal"/> values are equal, within the number of decimal
  335. places given by <paramref name="precision"/>. The values are rounded before comparison.
  336. </summary>
  337. <param name="expected">The expected value</param>
  338. <param name="actual">The value to be compared against</param>
  339. <param name="precision">The number of decimal places (valid values: 0-28)</param>
  340. <exception cref="T:Xunit.Sdk.EqualException">Thrown when the values are not equal</exception>
  341. </member>
  342. <member name="M:Xunit.Assert.Equal(System.DateTime,System.DateTime,System.TimeSpan)">
  343. <summary>
  344. Verifies that two <see cref="T:System.DateTime"/> values are equal, within the precision
  345. given by <paramref name="precision"/>.
  346. </summary>
  347. <param name="expected">The expected value</param>
  348. <param name="actual">The value to be compared against</param>
  349. <param name="precision">The allowed difference in time where the two dates are considered equal</param>
  350. <exception cref="T:Xunit.Sdk.EqualException">Thrown when the values are not equal</exception>
  351. </member>
  352. <member name="M:Xunit.Assert.StrictEqual``1(``0,``0)">
  353. <summary>
  354. Verifies that two objects are strictly equal, using the type's default comparer.
  355. </summary>
  356. <typeparam name="T">The type of the objects to be compared</typeparam>
  357. <param name="expected">The expected value</param>
  358. <param name="actual">The value to be compared against</param>
  359. <exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
  360. </member>
  361. <member name="M:Xunit.Assert.NotEqual``1(``0,``0)">
  362. <summary>
  363. Verifies that two objects are not equal, using a default comparer.
  364. </summary>
  365. <typeparam name="T">The type of the objects to be compared</typeparam>
  366. <param name="expected">The expected object</param>
  367. <param name="actual">The actual object</param>
  368. <exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
  369. </member>
  370. <member name="M:Xunit.Assert.NotEqual``1(``0,``0,System.Collections.Generic.IEqualityComparer{``0})">
  371. <summary>
  372. Verifies that two objects are not equal, using a custom equality comparer.
  373. </summary>
  374. <typeparam name="T">The type of the objects to be compared</typeparam>
  375. <param name="expected">The expected object</param>
  376. <param name="actual">The actual object</param>
  377. <param name="comparer">The comparer used to examine the objects</param>
  378. <exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
  379. </member>
  380. <member name="M:Xunit.Assert.NotEqual(System.Double,System.Double,System.Int32)">
  381. <summary>
  382. Verifies that two <see cref="T:System.Double"/> values are not equal, within the number of decimal
  383. places given by <paramref name="precision"/>.
  384. </summary>
  385. <param name="expected">The expected value</param>
  386. <param name="actual">The value to be compared against</param>
  387. <param name="precision">The number of decimal places (valid values: 0-15)</param>
  388. <exception cref="T:Xunit.Sdk.EqualException">Thrown when the values are equal</exception>
  389. </member>
  390. <member name="M:Xunit.Assert.NotEqual(System.Decimal,System.Decimal,System.Int32)">
  391. <summary>
  392. Verifies that two <see cref="T:System.Decimal"/> values are not equal, within the number of decimal
  393. places given by <paramref name="precision"/>.
  394. </summary>
  395. <param name="expected">The expected value</param>
  396. <param name="actual">The value to be compared against</param>
  397. <param name="precision">The number of decimal places (valid values: 0-28)</param>
  398. <exception cref="T:Xunit.Sdk.EqualException">Thrown when the values are equal</exception>
  399. </member>
  400. <member name="M:Xunit.Assert.NotStrictEqual``1(``0,``0)">
  401. <summary>
  402. Verifies that two objects are strictly not equal, using the type's default comparer.
  403. </summary>
  404. <typeparam name="T">The type of the objects to be compared</typeparam>
  405. <param name="expected">The expected object</param>
  406. <param name="actual">The actual object</param>
  407. <exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
  408. </member>
  409. <member name="M:Xunit.Assert.Raises``1(System.Action{System.EventHandler{``0}},System.Action{System.EventHandler{``0}},System.Action)">
  410. <summary>
  411. Verifies that a event with the exact event args is raised.
  412. </summary>
  413. <typeparam name="T">The type of the event arguments to expect</typeparam>
  414. <param name="attach">Code to attach the event handler</param>
  415. <param name="detach">Code to detach the event handler</param>
  416. <param name="testCode">A delegate to the code to be tested</param>
  417. <returns>The event sender and arguments wrapped in an object</returns>
  418. <exception cref="T:Xunit.Sdk.RaisesException">Thrown when the expected event was not raised.</exception>
  419. </member>
  420. <member name="M:Xunit.Assert.RaisesAny``1(System.Action{System.EventHandler{``0}},System.Action{System.EventHandler{``0}},System.Action)">
  421. <summary>
  422. Verifies that an event with the exact or a derived event args is raised.
  423. </summary>
  424. <typeparam name="T">The type of the event arguments to expect</typeparam>
  425. <param name="attach">Code to attach the event handler</param>
  426. <param name="detach">Code to detach the event handler</param>
  427. <param name="testCode">A delegate to the code to be tested</param>
  428. <returns>The event sender and arguments wrapped in an object</returns>
  429. <exception cref="T:Xunit.Sdk.RaisesException">Thrown when the expected event was not raised.</exception>
  430. </member>
  431. <member name="M:Xunit.Assert.RaisesAsync``1(System.Action{System.EventHandler{``0}},System.Action{System.EventHandler{``0}},System.Func{System.Threading.Tasks.Task})">
  432. <summary>
  433. Verifies that a event with the exact event args (and not a derived type) is raised.
  434. </summary>
  435. <typeparam name="T">The type of the event arguments to expect</typeparam>
  436. <param name="attach">Code to attach the event handler</param>
  437. <param name="detach">Code to detach the event handler</param>
  438. <param name="testCode">A delegate to the code to be tested</param>
  439. <returns>The event sender and arguments wrapped in an object</returns>
  440. <exception cref="T:Xunit.Sdk.RaisesException">Thrown when the expected event was not raised.</exception>
  441. </member>
  442. <member name="M:Xunit.Assert.RaisesAnyAsync``1(System.Action{System.EventHandler{``0}},System.Action{System.EventHandler{``0}},System.Func{System.Threading.Tasks.Task})">
  443. <summary>
  444. Verifies that an event with the exact or a derived event args is raised.
  445. </summary>
  446. <typeparam name="T">The type of the event arguments to expect</typeparam>
  447. <param name="attach">Code to attach the event handler</param>
  448. <param name="detach">Code to detach the event handler</param>
  449. <param name="testCode">A delegate to the code to be tested</param>
  450. <returns>The event sender and arguments wrapped in an object</returns>
  451. <exception cref="T:Xunit.Sdk.RaisesException">Thrown when the expected event was not raised.</exception>
  452. </member>
  453. <member name="T:Xunit.Assert.RaisedEvent`1">
  454. <summary>
  455. Represents a raised event after the fact.
  456. </summary>
  457. <typeparam name="T">The type of the event arguments.</typeparam>
  458. </member>
  459. <member name="P:Xunit.Assert.RaisedEvent`1.Sender">
  460. <summary>
  461. The sender of the event.
  462. </summary>
  463. </member>
  464. <member name="P:Xunit.Assert.RaisedEvent`1.Arguments">
  465. <summary>
  466. The event arguments.
  467. </summary>
  468. </member>
  469. <member name="M:Xunit.Assert.RaisedEvent`1.#ctor(System.Object,`0)">
  470. <summary>
  471. Creates a new instance of the <see cref="T:Xunit.Assert.RaisedEvent`1" /> class.
  472. </summary>
  473. <param name="sender">The sender of the event.</param>
  474. <param name="args">The event arguments</param>
  475. </member>
  476. <member name="M:Xunit.Assert.Throws``1(System.Action)">
  477. <summary>
  478. Verifies that the exact exception is thrown (and not a derived exception type).
  479. </summary>
  480. <typeparam name="T">The type of the exception expected to be thrown</typeparam>
  481. <param name="testCode">A delegate to the code to be tested</param>
  482. <returns>The exception that was thrown, when successful</returns>
  483. <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
  484. </member>
  485. <member name="M:Xunit.Assert.Throws``1(System.Func{System.Object})">
  486. <summary>
  487. Verifies that the exact exception is thrown (and not a derived exception type).
  488. Generally used to test property accessors.
  489. </summary>
  490. <typeparam name="T">The type of the exception expected to be thrown</typeparam>
  491. <param name="testCode">A delegate to the code to be tested</param>
  492. <returns>The exception that was thrown, when successful</returns>
  493. <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
  494. </member>
  495. <member name="M:Xunit.Assert.Throws``1(System.Func{System.Threading.Tasks.Task})">
  496. <summary/>
  497. </member>
  498. <member name="M:Xunit.Assert.ThrowsAsync``1(System.Func{System.Threading.Tasks.Task})">
  499. <summary>
  500. Verifies that the exact exception is thrown (and not a derived exception type).
  501. </summary>
  502. <typeparam name="T">The type of the exception expected to be thrown</typeparam>
  503. <param name="testCode">A delegate to the task to be tested</param>
  504. <returns>The exception that was thrown, when successful</returns>
  505. <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
  506. </member>
  507. <member name="M:Xunit.Assert.ThrowsAny``1(System.Action)">
  508. <summary>
  509. Verifies that the exact exception or a derived exception type is thrown.
  510. </summary>
  511. <typeparam name="T">The type of the exception expected to be thrown</typeparam>
  512. <param name="testCode">A delegate to the code to be tested</param>
  513. <returns>The exception that was thrown, when successful</returns>
  514. <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
  515. </member>
  516. <member name="M:Xunit.Assert.ThrowsAny``1(System.Func{System.Object})">
  517. <summary>
  518. Verifies that the exact exception or a derived exception type is thrown.
  519. Generally used to test property accessors.
  520. </summary>
  521. <typeparam name="T">The type of the exception expected to be thrown</typeparam>
  522. <param name="testCode">A delegate to the code to be tested</param>
  523. <returns>The exception that was thrown, when successful</returns>
  524. <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
  525. </member>
  526. <member name="M:Xunit.Assert.ThrowsAnyAsync``1(System.Func{System.Threading.Tasks.Task})">
  527. <summary>
  528. Verifies that the exact exception or a derived exception type is thrown.
  529. </summary>
  530. <typeparam name="T">The type of the exception expected to be thrown</typeparam>
  531. <param name="testCode">A delegate to the task to be tested</param>
  532. <returns>The exception that was thrown, when successful</returns>
  533. <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
  534. </member>
  535. <member name="M:Xunit.Assert.Throws(System.Type,System.Action)">
  536. <summary>
  537. Verifies that the exact exception is thrown (and not a derived exception type).
  538. </summary>
  539. <param name="exceptionType">The type of the exception expected to be thrown</param>
  540. <param name="testCode">A delegate to the code to be tested</param>
  541. <returns>The exception that was thrown, when successful</returns>
  542. <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
  543. </member>
  544. <member name="M:Xunit.Assert.Throws(System.Type,System.Func{System.Object})">
  545. <summary>
  546. Verifies that the exact exception is thrown (and not a derived exception type).
  547. Generally used to test property accessors.
  548. </summary>
  549. <param name="exceptionType">The type of the exception expected to be thrown</param>
  550. <param name="testCode">A delegate to the code to be tested</param>
  551. <returns>The exception that was thrown, when successful</returns>
  552. <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
  553. </member>
  554. <member name="M:Xunit.Assert.ThrowsAsync(System.Type,System.Func{System.Threading.Tasks.Task})">
  555. <summary>
  556. Verifies that the exact exception is thrown (and not a derived exception type).
  557. </summary>
  558. <param name="exceptionType">The type of the exception expected to be thrown</param>
  559. <param name="testCode">A delegate to the task to be tested</param>
  560. <returns>The exception that was thrown, when successful</returns>
  561. <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
  562. </member>
  563. <member name="M:Xunit.Assert.Throws``1(System.String,System.Action)">
  564. <summary>
  565. Verifies that the exact exception is thrown (and not a derived exception type), where the exception
  566. derives from <see cref="T:System.ArgumentException"/> and has the given parameter name.
  567. </summary>
  568. <param name="paramName">The parameter name that is expected to be in the exception</param>
  569. <param name="testCode">A delegate to the code to be tested</param>
  570. <returns>The exception that was thrown, when successful</returns>
  571. <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
  572. </member>
  573. <member name="M:Xunit.Assert.Throws``1(System.String,System.Func{System.Object})">
  574. <summary>
  575. Verifies that the exact exception is thrown (and not a derived exception type), where the exception
  576. derives from <see cref="T:System.ArgumentException"/> and has the given parameter name.
  577. </summary>
  578. <param name="paramName">The parameter name that is expected to be in the exception</param>
  579. <param name="testCode">A delegate to the code to be tested</param>
  580. <returns>The exception that was thrown, when successful</returns>
  581. <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
  582. </member>
  583. <member name="M:Xunit.Assert.Throws``1(System.String,System.Func{System.Threading.Tasks.Task})">
  584. <summary/>
  585. </member>
  586. <member name="M:Xunit.Assert.ThrowsAsync``1(System.String,System.Func{System.Threading.Tasks.Task})">
  587. <summary>
  588. Verifies that the exact exception is thrown (and not a derived exception type), where the exception
  589. derives from <see cref="T:System.ArgumentException"/> and has the given parameter name.
  590. </summary>
  591. <param name="paramName">The parameter name that is expected to be in the exception</param>
  592. <param name="testCode">A delegate to the task to be tested</param>
  593. <returns>The exception that was thrown, when successful</returns>
  594. <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
  595. </member>
  596. <member name="M:Xunit.Assert.GuardArgumentNotNull(System.String,System.Object)">
  597. <summary/>
  598. </member>
  599. <member name="M:Xunit.Assert.NotSame(System.Object,System.Object)">
  600. <summary>
  601. Verifies that two objects are not the same instance.
  602. </summary>
  603. <param name="expected">The expected object instance</param>
  604. <param name="actual">The actual object instance</param>
  605. <exception cref="T:Xunit.Sdk.NotSameException">Thrown when the objects are the same instance</exception>
  606. </member>
  607. <member name="M:Xunit.Assert.Same(System.Object,System.Object)">
  608. <summary>
  609. Verifies that two objects are the same instance.
  610. </summary>
  611. <param name="expected">The expected object instance</param>
  612. <param name="actual">The actual object instance</param>
  613. <exception cref="T:Xunit.Sdk.SameException">Thrown when the objects are not the same instance</exception>
  614. </member>
  615. <member name="M:Xunit.Assert.NotNull(System.Object)">
  616. <summary>
  617. Verifies that an object reference is not null.
  618. </summary>
  619. <param name="object">The object to be validated</param>
  620. <exception cref="T:Xunit.Sdk.NotNullException">Thrown when the object is not null</exception>
  621. </member>
  622. <member name="M:Xunit.Assert.Null(System.Object)">
  623. <summary>
  624. Verifies that an object reference is null.
  625. </summary>
  626. <param name="object">The object to be inspected</param>
  627. <exception cref="T:Xunit.Sdk.NullException">Thrown when the object reference is not null</exception>
  628. </member>
  629. <member name="M:Xunit.Assert.PropertyChanged(System.ComponentModel.INotifyPropertyChanged,System.String,System.Action)">
  630. <summary>
  631. Verifies that the provided object raised <see cref="E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged"/>
  632. as a result of executing the given test code.
  633. </summary>
  634. <param name="object">The object which should raise the notification</param>
  635. <param name="propertyName">The property name for which the notification should be raised</param>
  636. <param name="testCode">The test code which should cause the notification to be raised</param>
  637. <exception cref="T:Xunit.Sdk.PropertyChangedException">Thrown when the notification is not raised</exception>
  638. </member>
  639. <member name="M:Xunit.Assert.PropertyChanged(System.ComponentModel.INotifyPropertyChanged,System.String,System.Func{System.Threading.Tasks.Task})">
  640. <summary/>
  641. </member>
  642. <member name="M:Xunit.Assert.PropertyChangedAsync(System.ComponentModel.INotifyPropertyChanged,System.String,System.Func{System.Threading.Tasks.Task})">
  643. <summary>
  644. Verifies that the provided object raised <see cref="E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged"/>
  645. as a result of executing the given test code.
  646. </summary>
  647. <param name="object">The object which should raise the notification</param>
  648. <param name="propertyName">The property name for which the notification should be raised</param>
  649. <param name="testCode">The test code which should cause the notification to be raised</param>
  650. <exception cref="T:Xunit.Sdk.PropertyChangedException">Thrown when the notification is not raised</exception>
  651. </member>
  652. <member name="M:Xunit.Assert.InRange``1(``0,``0,``0)">
  653. <summary>
  654. Verifies that a value is within a given range.
  655. </summary>
  656. <typeparam name="T">The type of the value to be compared</typeparam>
  657. <param name="actual">The actual value to be evaluated</param>
  658. <param name="low">The (inclusive) low value of the range</param>
  659. <param name="high">The (inclusive) high value of the range</param>
  660. <exception cref="T:Xunit.Sdk.InRangeException">Thrown when the value is not in the given range</exception>
  661. </member>
  662. <member name="M:Xunit.Assert.InRange``1(``0,``0,``0,System.Collections.Generic.IComparer{``0})">
  663. <summary>
  664. Verifies that a value is within a given range, using a comparer.
  665. </summary>
  666. <typeparam name="T">The type of the value to be compared</typeparam>
  667. <param name="actual">The actual value to be evaluated</param>
  668. <param name="low">The (inclusive) low value of the range</param>
  669. <param name="high">The (inclusive) high value of the range</param>
  670. <param name="comparer">The comparer used to evaluate the value's range</param>
  671. <exception cref="T:Xunit.Sdk.InRangeException">Thrown when the value is not in the given range</exception>
  672. </member>
  673. <member name="M:Xunit.Assert.NotInRange``1(``0,``0,``0)">
  674. <summary>
  675. Verifies that a value is not within a given range, using the default comparer.
  676. </summary>
  677. <typeparam name="T">The type of the value to be compared</typeparam>
  678. <param name="actual">The actual value to be evaluated</param>
  679. <param name="low">The (inclusive) low value of the range</param>
  680. <param name="high">The (inclusive) high value of the range</param>
  681. <exception cref="T:Xunit.Sdk.NotInRangeException">Thrown when the value is in the given range</exception>
  682. </member>
  683. <member name="M:Xunit.Assert.NotInRange``1(``0,``0,``0,System.Collections.Generic.IComparer{``0})">
  684. <summary>
  685. Verifies that a value is not within a given range, using a comparer.
  686. </summary>
  687. <typeparam name="T">The type of the value to be compared</typeparam>
  688. <param name="actual">The actual value to be evaluated</param>
  689. <param name="low">The (inclusive) low value of the range</param>
  690. <param name="high">The (inclusive) high value of the range</param>
  691. <param name="comparer">The comparer used to evaluate the value's range</param>
  692. <exception cref="T:Xunit.Sdk.NotInRangeException">Thrown when the value is in the given range</exception>
  693. </member>
  694. <member name="M:Xunit.Assert.RecordException(System.Action)">
  695. <summary>
  696. Records any exception which is thrown by the given code.
  697. </summary>
  698. <param name="testCode">The code which may thrown an exception.</param>
  699. <returns>Returns the exception that was thrown by the code; null, otherwise.</returns>
  700. </member>
  701. <member name="M:Xunit.Assert.RecordException(System.Func{System.Object})">
  702. <summary>
  703. Records any exception which is thrown by the given code that has
  704. a return value. Generally used for testing property accessors.
  705. </summary>
  706. <param name="testCode">The code which may thrown an exception.</param>
  707. <returns>Returns the exception that was thrown by the code; null, otherwise.</returns>
  708. </member>
  709. <member name="M:Xunit.Assert.RecordException(System.Func{System.Threading.Tasks.Task})">
  710. <summary/>
  711. </member>
  712. <member name="M:Xunit.Assert.RecordExceptionAsync(System.Func{System.Threading.Tasks.Task})">
  713. <summary>
  714. Records any exception which is thrown by the given task.
  715. </summary>
  716. <param name="testCode">The task which may thrown an exception.</param>
  717. <returns>Returns the exception that was thrown by the code; null, otherwise.</returns>
  718. </member>
  719. <member name="M:Xunit.Assert.ProperSubset``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.ISet{``0})">
  720. <summary>
  721. Verifies that a set is a proper subset of another set.
  722. </summary>
  723. <typeparam name="T">The type of the object to be verified</typeparam>
  724. <param name="expectedSuperset">The expected superset</param>
  725. <param name="actual">The set expected to be a proper subset</param>
  726. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the actual set is not a proper subset of the expected set</exception>
  727. </member>
  728. <member name="M:Xunit.Assert.ProperSuperset``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.ISet{``0})">
  729. <summary>
  730. Verifies that a set is a proper superset of another set.
  731. </summary>
  732. <typeparam name="T">The type of the object to be verified</typeparam>
  733. <param name="expectedSubset">The expected subset</param>
  734. <param name="actual">The set expected to be a proper superset</param>
  735. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the actual set is not a proper superset of the expected set</exception>
  736. </member>
  737. <member name="M:Xunit.Assert.Subset``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.ISet{``0})">
  738. <summary>
  739. Verifies that a set is a subset of another set.
  740. </summary>
  741. <typeparam name="T">The type of the object to be verified</typeparam>
  742. <param name="expectedSuperset">The expected superset</param>
  743. <param name="actual">The set expected to be a subset</param>
  744. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the actual set is not a subset of the expected set</exception>
  745. </member>
  746. <member name="M:Xunit.Assert.Superset``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.ISet{``0})">
  747. <summary>
  748. Verifies that a set is a superset of another set.
  749. </summary>
  750. <typeparam name="T">The type of the object to be verified</typeparam>
  751. <param name="expectedSubset">The expected subset</param>
  752. <param name="actual">The set expected to be a superset</param>
  753. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the actual set is not a superset of the expected set</exception>
  754. </member>
  755. <member name="M:Xunit.Assert.Contains(System.String,System.String)">
  756. <summary>
  757. Verifies that a string contains a given sub-string, using the current culture.
  758. </summary>
  759. <param name="expectedSubstring">The sub-string expected to be in the string</param>
  760. <param name="actualString">The string to be inspected</param>
  761. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the sub-string is not present inside the string</exception>
  762. </member>
  763. <member name="M:Xunit.Assert.Contains(System.String,System.String,System.StringComparison)">
  764. <summary>
  765. Verifies that a string contains a given sub-string, using the given comparison type.
  766. </summary>
  767. <param name="expectedSubstring">The sub-string expected to be in the string</param>
  768. <param name="actualString">The string to be inspected</param>
  769. <param name="comparisonType">The type of string comparison to perform</param>
  770. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the sub-string is not present inside the string</exception>
  771. </member>
  772. <member name="M:Xunit.Assert.DoesNotContain(System.String,System.String)">
  773. <summary>
  774. Verifies that a string does not contain a given sub-string, using the current culture.
  775. </summary>
  776. <param name="expectedSubstring">The sub-string which is expected not to be in the string</param>
  777. <param name="actualString">The string to be inspected</param>
  778. <exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the sub-string is present inside the string</exception>
  779. </member>
  780. <member name="M:Xunit.Assert.DoesNotContain(System.String,System.String,System.StringComparison)">
  781. <summary>
  782. Verifies that a string does not contain a given sub-string, using the current culture.
  783. </summary>
  784. <param name="expectedSubstring">The sub-string which is expected not to be in the string</param>
  785. <param name="actualString">The string to be inspected</param>
  786. <param name="comparisonType">The type of string comparison to perform</param>
  787. <exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the sub-string is present inside the given string</exception>
  788. </member>
  789. <member name="M:Xunit.Assert.StartsWith(System.String,System.String)">
  790. <summary>
  791. Verifies that a string starts with a given string, using the current culture.
  792. </summary>
  793. <param name="expectedStartString">The string expected to be at the start of the string</param>
  794. <param name="actualString">The string to be inspected</param>
  795. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the string does not start with the expected string</exception>
  796. </member>
  797. <member name="M:Xunit.Assert.StartsWith(System.String,System.String,System.StringComparison)">
  798. <summary>
  799. Verifies that a string starts with a given string, using the given comparison type.
  800. </summary>
  801. <param name="expectedStartString">The string expected to be at the start of the string</param>
  802. <param name="actualString">The string to be inspected</param>
  803. <param name="comparisonType">The type of string comparison to perform</param>
  804. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the string does not start with the expected string</exception>
  805. </member>
  806. <member name="M:Xunit.Assert.EndsWith(System.String,System.String)">
  807. <summary>
  808. Verifies that a string ends with a given string, using the current culture.
  809. </summary>
  810. <param name="expectedEndString">The string expected to be at the end of the string</param>
  811. <param name="actualString">The string to be inspected</param>
  812. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the string does not end with the expected string</exception>
  813. </member>
  814. <member name="M:Xunit.Assert.EndsWith(System.String,System.String,System.StringComparison)">
  815. <summary>
  816. Verifies that a string ends with a given string, using the given comparison type.
  817. </summary>
  818. <param name="expectedEndString">The string expected to be at the end of the string</param>
  819. <param name="actualString">The string to be inspected</param>
  820. <param name="comparisonType">The type of string comparison to perform</param>
  821. <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the string does not end with the expected string</exception>
  822. </member>
  823. <member name="M:Xunit.Assert.Matches(System.String,System.String)">
  824. <summary>
  825. Verifies that a string matches a regular expression.
  826. </summary>
  827. <param name="expectedRegexPattern">The regex pattern expected to match</param>
  828. <param name="actualString">The string to be inspected</param>
  829. <exception cref="T:Xunit.Sdk.MatchesException">Thrown when the string does not match the regex pattern</exception>
  830. </member>
  831. <member name="M:Xunit.Assert.Matches(System.Text.RegularExpressions.Regex,System.String)">
  832. <summary>
  833. Verifies that a string matches a regular expression.
  834. </summary>
  835. <param name="expectedRegex">The regex expected to match</param>
  836. <param name="actualString">The string to be inspected</param>
  837. <exception cref="T:Xunit.Sdk.MatchesException">Thrown when the string does not match the regex</exception>
  838. </member>
  839. <member name="M:Xunit.Assert.DoesNotMatch(System.String,System.String)">
  840. <summary>
  841. Verifies that a string does not match a regular expression.
  842. </summary>
  843. <param name="expectedRegexPattern">The regex pattern expected not to match</param>
  844. <param name="actualString">The string to be inspected</param>
  845. <exception cref="T:Xunit.Sdk.DoesNotMatchException">Thrown when the string matches the regex pattern</exception>
  846. </member>
  847. <member name="M:Xunit.Assert.DoesNotMatch(System.Text.RegularExpressions.Regex,System.String)">
  848. <summary>
  849. Verifies that a string does not match a regular expression.
  850. </summary>
  851. <param name="expectedRegex">The regex expected not to match</param>
  852. <param name="actualString">The string to be inspected</param>
  853. <exception cref="T:Xunit.Sdk.DoesNotMatchException">Thrown when the string matches the regex</exception>
  854. </member>
  855. <member name="M:Xunit.Assert.Equal(System.String,System.String)">
  856. <summary>
  857. Verifies that two strings are equivalent.
  858. </summary>
  859. <param name="expected">The expected string value.</param>
  860. <param name="actual">The actual string value.</param>
  861. <exception cref="T:Xunit.Sdk.EqualException">Thrown when the strings are not equivalent.</exception>
  862. </member>
  863. <member name="M:Xunit.Assert.Equal(System.String,System.String,System.Boolean,System.Boolean,System.Boolean)">
  864. <summary>
  865. Verifies that two strings are equivalent.
  866. </summary>
  867. <param name="expected">The expected string value.</param>
  868. <param name="actual">The actual string value.</param>
  869. <param name="ignoreCase">If set to <c>true</c>, ignores cases differences. The invariant culture is used.</param>
  870. <param name="ignoreLineEndingDifferences">If set to <c>true</c>, treats \r\n, \r, and \n as equivalent.</param>
  871. <param name="ignoreWhiteSpaceDifferences">If set to <c>true</c>, treats spaces and tabs (in any non-zero quantity) as equivalent.</param>
  872. <exception cref="T:Xunit.Sdk.EqualException">Thrown when the strings are not equivalent.</exception>
  873. </member>
  874. <member name="M:Xunit.Assert.IsAssignableFrom``1(System.Object)">
  875. <summary>
  876. Verifies that an object is of the given type or a derived type.
  877. </summary>
  878. <typeparam name="T">The type the object should be</typeparam>
  879. <param name="object">The object to be evaluated</param>
  880. <returns>The object, casted to type T when successful</returns>
  881. <exception cref="T:Xunit.Sdk.IsAssignableFromException">Thrown when the object is not the given type</exception>
  882. </member>
  883. <member name="M:Xunit.Assert.IsAssignableFrom(System.Type,System.Object)">
  884. <summary>
  885. Verifies that an object is of the given type or a derived type.
  886. </summary>
  887. <param name="expectedType">The type the object should be</param>
  888. <param name="object">The object to be evaluated</param>
  889. <exception cref="T:Xunit.Sdk.IsAssignableFromException">Thrown when the object is not the given type</exception>
  890. </member>
  891. <member name="M:Xunit.Assert.IsNotType``1(System.Object)">
  892. <summary>
  893. Verifies that an object is not exactly the given type.
  894. </summary>
  895. <typeparam name="T">The type the object should not be</typeparam>
  896. <param name="object">The object to be evaluated</param>
  897. <exception cref="T:Xunit.Sdk.IsNotTypeException">Thrown when the object is the given type</exception>
  898. </member>
  899. <member name="M:Xunit.Assert.IsNotType(System.Type,System.Object)">
  900. <summary>
  901. Verifies that an object is not exactly the given type.
  902. </summary>
  903. <param name="expectedType">The type the object should not be</param>
  904. <param name="object">The object to be evaluated</param>
  905. <exception cref="T:Xunit.Sdk.IsNotTypeException">Thrown when the object is the given type</exception>
  906. </member>
  907. <member name="M:Xunit.Assert.IsType``1(System.Object)">
  908. <summary>
  909. Verifies that an object is exactly the given type (and not a derived type).
  910. </summary>
  911. <typeparam name="T">The type the object should be</typeparam>
  912. <param name="object">The object to be evaluated</param>
  913. <returns>The object, casted to type T when successful</returns>
  914. <exception cref="T:Xunit.Sdk.IsTypeException">Thrown when the object is not the given type</exception>
  915. </member>
  916. <member name="M:Xunit.Assert.IsType(System.Type,System.Object)">
  917. <summary>
  918. Verifies that an object is exactly the given type (and not a derived type).
  919. </summary>
  920. <param name="expectedType">The type the object should be</param>
  921. <param name="object">The object to be evaluated</param>
  922. <exception cref="T:Xunit.Sdk.IsTypeException">Thrown when the object is not the given type</exception>
  923. </member>
  924. <member name="T:Xunit.Sdk.ArgumentFormatter">
  925. <summary>
  926. Formats arguments for display in theories.
  927. </summary>
  928. </member>
  929. <member name="M:Xunit.Sdk.ArgumentFormatter.Format(System.Object)">
  930. <summary>
  931. Format the value for presentation.
  932. </summary>
  933. <param name="value">The value to be formatted.</param>
  934. <returns>The formatted value.</returns>
  935. </member>
  936. <member name="T:Xunit.Sdk.AssertComparer`1">
  937. <summary>
  938. Default implementation of <see cref="T:System.Collections.Generic.IComparer`1"/> used by the xUnit.net range assertions.
  939. </summary>
  940. <typeparam name="T">The type that is being compared.</typeparam>
  941. </member>
  942. <member name="M:Xunit.Sdk.AssertComparer`1.Compare(`0,`0)">
  943. <inheritdoc/>
  944. </member>
  945. <member name="T:Xunit.Sdk.AssertEqualityComparer`1">
  946. <summary>
  947. Default implementation of <see cref="T:System.Collections.Generic.IEqualityComparer`1"/> used by the xUnit.net equality assertions.
  948. </summary>
  949. <typeparam name="T">The type that is being compared.</typeparam>
  950. </member>
  951. <member name="M:Xunit.Sdk.AssertEqualityComparer`1.#ctor(System.Collections.IEqualityComparer)">
  952. <summary>
  953. Initializes a new instance of the <see cref="T:Xunit.Sdk.AssertEqualityComparer`1" /> class.
  954. </summary>
  955. <param name="innerComparer">The inner comparer to be used when the compared objects are enumerable.</param>
  956. </member>
  957. <member name="M:Xunit.Sdk.AssertEqualityComparer`1.Equals(`0,`0)">
  958. <inheritdoc/>
  959. </member>
  960. <member name="M:Xunit.Sdk.AssertEqualityComparer`1.GetHashCode(`0)">
  961. <inheritdoc/>
  962. </member>
  963. <member name="T:Xunit.Sdk.AssertEqualityComparerAdapter`1">
  964. <summary>
  965. A class that wraps <see cref="T:System.Collections.Generic.IEqualityComparer`1"/> to create <see cref="T:System.Collections.IEqualityComparer"/>.
  966. </summary>
  967. <typeparam name="T">The type that is being compared.</typeparam>
  968. </member>
  969. <member name="M:Xunit.Sdk.AssertEqualityComparerAdapter`1.#ctor(System.Collections.Generic.IEqualityComparer{`0})">
  970. <summary>
  971. Initializes a new instance of the <see cref="T:Xunit.Sdk.AssertEqualityComparerAdapter`1"/> class.
  972. </summary>
  973. <param name="innerComparer">The comparer that is being adapted.</param>
  974. </member>
  975. <member name="M:Xunit.Sdk.AssertEqualityComparerAdapter`1.Equals(System.Object,System.Object)">
  976. <inheritdoc/>
  977. </member>
  978. <member name="M:Xunit.Sdk.AssertEqualityComparerAdapter`1.GetHashCode(System.Object)">
  979. <inheritdoc/>
  980. </member>
  981. <member name="T:Xunit.Sdk.AllException">
  982. <summary>
  983. Exception thrown when an All assertion has one or more items fail an assertion.
  984. </summary>
  985. </member>
  986. <member name="M:Xunit.Sdk.AllException.#ctor(System.Int32,System.Tuple{System.Int32,System.Object,System.Exception}[])">
  987. <summary>
  988. Creates a new instance of the <see cref="T:Xunit.Sdk.AllException"/> class.
  989. </summary>
  990. <param name="totalItems">The total number of items that were in the collection.</param>
  991. <param name="errors">The list of errors that occurred during the test pass.</param>
  992. </member>
  993. <member name="P:Xunit.Sdk.AllException.Failures">
  994. <summary>
  995. The errors that occurred during execution of the test.
  996. </summary>
  997. </member>
  998. <member name="P:Xunit.Sdk.AllException.Message">
  999. <inheritdoc/>
  1000. </member>
  1001. <member name="T:Xunit.Sdk.AssertActualExpectedException">
  1002. <summary>
  1003. Base class for exceptions that have actual and expected values
  1004. </summary>
  1005. </member>
  1006. <member name="M:Xunit.Sdk.AssertActualExpectedException.#ctor(System.Object,System.Object,System.String,System.String,System.String)">
  1007. <summary>
  1008. Creates a new instance of the <see href="AssertActualExpectedException"/> class.
  1009. </summary>
  1010. <param name="expected">The expected value</param>
  1011. <param name="actual">The actual value</param>
  1012. <param name="userMessage">The user message to be shown</param>
  1013. <param name="expectedTitle">The title to use for the expected value (defaults to "Expected")</param>
  1014. <param name="actualTitle">The title to use for the actual value (defaults to "Actual")</param>
  1015. </member>
  1016. <member name="M:Xunit.Sdk.AssertActualExpectedException.#ctor(System.Object,System.Object,System.String,System.String,System.String,System.Exception)">
  1017. <summary>
  1018. Creates a new instance of the <see href="AssertActualExpectedException"/> class.
  1019. </summary>
  1020. <param name="expected">The expected value</param>
  1021. <param name="actual">The actual value</param>
  1022. <param name="userMessage">The user message to be shown</param>
  1023. <param name="expectedTitle">The title to use for the expected value (defaults to "Expected")</param>
  1024. <param name="actualTitle">The title to use for the actual value (defaults to "Actual")</param>
  1025. <param name="innerException">The inner exception.</param>
  1026. </member>
  1027. <member name="P:Xunit.Sdk.AssertActualExpectedException.Actual">
  1028. <summary>
  1029. Gets the actual value.
  1030. </summary>
  1031. </member>
  1032. <member name="P:Xunit.Sdk.AssertActualExpectedException.ActualTitle">
  1033. <summary>
  1034. Gets the title used for the actual value.
  1035. </summary>
  1036. </member>
  1037. <member name="P:Xunit.Sdk.AssertActualExpectedException.Expected">
  1038. <summary>
  1039. Gets the expected value.
  1040. </summary>
  1041. </member>
  1042. <member name="P:Xunit.Sdk.AssertActualExpectedException.ExpectedTitle">
  1043. <summary>
  1044. Gets the title used for the expected value.
  1045. </summary>
  1046. </member>
  1047. <member name="P:Xunit.Sdk.AssertActualExpectedException.Message">
  1048. <summary>
  1049. Gets a message that describes the current exception. Includes the expected and actual values.
  1050. </summary>
  1051. <returns>The error message that explains the reason for the exception, or an empty string("").</returns>
  1052. <filterpriority>1</filterpriority>
  1053. </member>
  1054. <member name="T:Xunit.Sdk.AssertCollectionCountException">
  1055. <summary>
  1056. Exception thrown when the collection did not contain exactly the given number element.
  1057. </summary>
  1058. </member>
  1059. <member name="M:Xunit.Sdk.AssertCollectionCountException.#ctor(System.Int32,System.Int32)">
  1060. <summary>
  1061. Initializes a new instance of the <see cref="T:Xunit.Sdk.AssertCollectionCountException"/> class.
  1062. </summary>
  1063. <param name="expectedCount">The expected number of items in the collection.</param>
  1064. <param name="actualCount">The actual number of items in the collection.</param>
  1065. </member>
  1066. <member name="T:Xunit.Sdk.CollectionException">
  1067. <summary>
  1068. Exception thrown when Assert.Collection fails.
  1069. </summary>
  1070. </member>
  1071. <member name="M:Xunit.Sdk.CollectionException.#ctor(System.Object,System.Int32,System.Int32,System.Int32,System.Exception)">
  1072. <summary>
  1073. Creates a new instance of the <see cref="T:Xunit.Sdk.CollectionException"/> class.
  1074. </summary>
  1075. <param name="collection">The collection that failed the test.</param>
  1076. <param name="expectedCount">The expected number of items in the collection.</param>
  1077. <param name="actualCount">The actual number of items in the collection.</param>
  1078. <param name="indexFailurePoint">The index of the position where the first comparison failure occurred.</param>
  1079. <param name="innerException">The exception that was thrown during the comparison failure.</param>
  1080. </member>
  1081. <member name="P:Xunit.Sdk.CollectionException.Collection">
  1082. <summary>
  1083. The collection that failed the test.
  1084. </summary>
  1085. </member>
  1086. <member name="P:Xunit.Sdk.CollectionException.ActualCount">
  1087. <summary>
  1088. The actual number of items in the collection.
  1089. </summary>
  1090. </member>
  1091. <member name="P:Xunit.Sdk.CollectionException.ExpectedCount">
  1092. <summary>
  1093. The expected number of items in the collection.
  1094. </summary>
  1095. </member>
  1096. <member name="P:Xunit.Sdk.CollectionException.IndexFailurePoint">
  1097. <summary>
  1098. The index of the position where the first comparison failure occurred, or -1 if
  1099. comparisions did not occur (because the actual and expected counts differed).
  1100. </summary>
  1101. </member>
  1102. <member name="P:Xunit.Sdk.CollectionException.Message">
  1103. <inheritdoc/>
  1104. </member>
  1105. <member name="P:Xunit.Sdk.CollectionException.StackTrace">
  1106. <inheritdoc/>
  1107. </member>
  1108. <member name="T:Xunit.Sdk.ContainsException">
  1109. <summary>
  1110. Exception thrown when a collection unexpectedly does not contain the expected value.
  1111. </summary>
  1112. </member>
  1113. <member name="M:Xunit.Sdk.ContainsException.#ctor(System.Object,System.Object)">
  1114. <summary>
  1115. Creates a new instance of the <see cref="T:Xunit.Sdk.ContainsException"/> class.
  1116. </summary>
  1117. <param name="expected">The expected object value</param>
  1118. <param name="actual">The actual value</param>
  1119. </member>
  1120. <member name="T:Xunit.Sdk.DoesNotContainException">
  1121. <summary>
  1122. Exception thrown when a collection unexpectedly contains the expected value.
  1123. </summary>
  1124. </member>
  1125. <member name="M:Xunit.Sdk.DoesNotContainException.#ctor(System.Object,System.Object)">
  1126. <summary>
  1127. Creates a new instance of the <see cref="T:Xunit.Sdk.DoesNotContainException"/> class.
  1128. </summary>
  1129. <param name="expected">The expected object value</param>
  1130. <param name="actual">The actual value</param>
  1131. </member>
  1132. <member name="T:Xunit.Sdk.DoesNotMatchException">
  1133. <summary>
  1134. Exception thrown when a string unexpectedly matches a regular expression.
  1135. </summary>
  1136. </member>
  1137. <member name="M:Xunit.Sdk.DoesNotMatchException.#ctor(System.Object,System.Object)">
  1138. <summary>
  1139. Creates a new instance of the <see cref="T:Xunit.Sdk.DoesNotMatchException"/> class.
  1140. </summary>
  1141. <param name="expectedRegexPattern">The regular expression pattern expected not to match</param>
  1142. <param name="actual">The actual value</param>
  1143. </member>
  1144. <member name="T:Xunit.Sdk.EmptyException">
  1145. <summary>
  1146. Exception thrown when a collection is unexpectedly not empty.
  1147. </summary>
  1148. </member>
  1149. <member name="M:Xunit.Sdk.EmptyException.#ctor(System.Collections.IEnumerable)">
  1150. <summary>
  1151. Creates a new instance of the <see cref="T:Xunit.Sdk.EmptyException"/> class.
  1152. </summary>
  1153. </member>
  1154. <member name="P:Xunit.Sdk.EmptyException.Collection">
  1155. <summary>
  1156. The collection that failed the test.
  1157. </summary>
  1158. </member>
  1159. <member name="P:Xunit.Sdk.EmptyException.Message">
  1160. <inheritdoc/>
  1161. </member>
  1162. <member name="T:Xunit.Sdk.EndsWithException">
  1163. <summary>
  1164. Exception thrown when a string does not end with the expected value.
  1165. </summary>
  1166. </member>
  1167. <member name="M:Xunit.Sdk.EndsWithException.#ctor(System.String,System.String)">
  1168. <summary>
  1169. Creates a new instance of the <see cref="T:Xunit.Sdk.EndsWithException"/> class.
  1170. </summary>
  1171. <param name="expected">The expected string value</param>
  1172. <param name="actual">The actual value</param>
  1173. </member>
  1174. <member name="T:Xunit.Sdk.EqualException">
  1175. <summary>
  1176. Exception thrown when two values are unexpectedly not equal.
  1177. </summary>
  1178. </member>
  1179. <member name="M:Xunit.Sdk.EqualException.#ctor(System.Object,System.Object)">
  1180. <summary>
  1181. Creates a new instance of the <see cref="T:Xunit.Sdk.EqualException"/> class.
  1182. </summary>
  1183. <param name="expected">The expected object value</param>
  1184. <param name="actual">The actual object value</param>
  1185. </member>
  1186. <member name="M:Xunit.Sdk.EqualException.#ctor(System.String,System.String,System.Int32,System.Int32)">
  1187. <summary>
  1188. Creates a new instance of the <see cref="T:Xunit.Sdk.EqualException"/> class for string comparisons.
  1189. </summary>
  1190. <param name="expected">The expected string value</param>
  1191. <param name="actual">The actual string value</param>
  1192. <param name="expectedIndex">The first index in the expected string where the strings differ</param>
  1193. <param name="actualIndex">The first index in the actual string where the strings differ</param>
  1194. </member>
  1195. <member name="P:Xunit.Sdk.EqualException.ActualIndex">
  1196. <summary>
  1197. Gets the index into the actual value where the values first differed.
  1198. Returns -1 if the difference index points were not provided.
  1199. </summary>
  1200. </member>
  1201. <member name="P:Xunit.Sdk.EqualException.ExpectedIndex">
  1202. <summary>
  1203. Gets the index into the expected value where the values first differed.
  1204. Returns -1 if the difference index points were not provided.
  1205. </summary>
  1206. </member>
  1207. <member name="P:Xunit.Sdk.EqualException.Message">
  1208. <inheritdoc/>
  1209. </member>
  1210. <member name="T:Xunit.Sdk.FalseException">
  1211. <summary>
  1212. Exception thrown when a value is unexpectedly true.
  1213. </summary>
  1214. </member>
  1215. <member name="M:Xunit.Sdk.FalseException.#ctor(System.String,System.Nullable{System.Boolean})">
  1216. <summary>
  1217. Creates a new instance of the <see cref="T:Xunit.Sdk.FalseException"/> class.
  1218. </summary>
  1219. <param name="userMessage">The user message to be display, or null for the default message</param>
  1220. <param name="value">The actual value</param>
  1221. </member>
  1222. <member name="T:Xunit.Sdk.InRangeException">
  1223. <summary>
  1224. Exception thrown when a value is unexpectedly not in the given range.
  1225. </summary>
  1226. </member>
  1227. <member name="M:Xunit.Sdk.InRangeException.#ctor(System.Object,System.Object,System.Object)">
  1228. <summary>
  1229. Creates a new instance of the <see cref="T:Xunit.Sdk.InRangeException"/> class.
  1230. </summary>
  1231. <param name="actual">The actual object value</param>
  1232. <param name="low">The low value of the range</param>
  1233. <param name="high">The high value of the range</param>
  1234. </member>
  1235. <member name="P:Xunit.Sdk.InRangeException.Actual">
  1236. <summary>
  1237. Gets the actual object value
  1238. </summary>
  1239. </member>
  1240. <member name="P:Xunit.Sdk.InRangeException.High">
  1241. <summary>
  1242. Gets the high value of the range
  1243. </summary>
  1244. </member>
  1245. <member name="P:Xunit.Sdk.InRangeException.Low">
  1246. <summary>
  1247. Gets the low value of the range
  1248. </summary>
  1249. </member>
  1250. <member name="P:Xunit.Sdk.InRangeException.Message">
  1251. <summary>
  1252. Gets a message that describes the current exception.
  1253. </summary>
  1254. <returns>The error message that explains the reason for the exception, or an empty string("").</returns>
  1255. </member>
  1256. <member name="T:Xunit.Sdk.IsAssignableFromException">
  1257. <summary>
  1258. Exception thrown when the value is unexpectedly not of the given type or a derived type.
  1259. </summary>
  1260. </member>
  1261. <member name="M:Xunit.Sdk.IsAssignableFromException.#ctor(System.Type,System.Object)">
  1262. <summary>
  1263. Creates a new instance of the <see cref="T:Xunit.Sdk.IsTypeException"/> class.
  1264. </summary>
  1265. <param name="expected">The expected type</param>
  1266. <param name="actual">The actual object value</param>
  1267. </member>
  1268. <member name="T:Xunit.Sdk.IsNotTypeException">
  1269. <summary>
  1270. Exception thrown when the value is unexpectedly of the exact given type.
  1271. </summary>
  1272. </member>
  1273. <member name="M:Xunit.Sdk.IsNotTypeException.#ctor(System.Type,System.Object)">
  1274. <summary>
  1275. Creates a new instance of the <see cref="T:Xunit.Sdk.IsNotTypeException"/> class.
  1276. </summary>
  1277. <param name="expected">The expected type</param>
  1278. <param name="actual">The actual object value</param>
  1279. </member>
  1280. <member name="T:Xunit.Sdk.IsTypeException">
  1281. <summary>
  1282. Exception thrown when the value is unexpectedly not of the exact given type.
  1283. </summary>
  1284. </member>
  1285. <member name="M:Xunit.Sdk.IsTypeException.#ctor(System.String,System.String)">
  1286. <summary>
  1287. Creates a new instance of the <see cref="T:Xunit.Sdk.IsTypeException"/> class.
  1288. </summary>
  1289. <param name="expectedTypeName">The expected type name</param>
  1290. <param name="actualTypeName">The actual type name</param>
  1291. </member>
  1292. <member name="T:Xunit.Sdk.MatchesException">
  1293. <summary>
  1294. Exception thrown when a string does not match a regular expression.
  1295. </summary>
  1296. </member>
  1297. <member name="M:Xunit.Sdk.MatchesException.#ctor(System.Object,System.Object)">
  1298. <summary>
  1299. Creates a new instance of the <see cref="T:Xunit.Sdk.MatchesException"/> class.
  1300. </summary>
  1301. <param name="expectedRegexPattern">The expected regular expression pattern</param>
  1302. <param name="actual">The actual value</param>
  1303. </member>
  1304. <member name="T:Xunit.Sdk.NotEmptyException">
  1305. <summary>
  1306. Exception thrown when a collection is unexpectedly empty.
  1307. </summary>
  1308. </member>
  1309. <member name="M:Xunit.Sdk.NotEmptyException.#ctor">
  1310. <summary>
  1311. Creates a new instance of the <see cref="T:Xunit.Sdk.NotEmptyException"/> class.
  1312. </summary>
  1313. </member>
  1314. <member name="T:Xunit.Sdk.NotEqualException">
  1315. <summary>
  1316. Exception thrown when two values are unexpectedly equal.
  1317. </summary>
  1318. </member>
  1319. <member name="M:Xunit.Sdk.NotEqualException.#ctor(System.String,System.String)">
  1320. <summary>
  1321. Creates a new instance of the <see cref="T:Xunit.Sdk.NotEqualException"/> class.
  1322. </summary>
  1323. </member>
  1324. <member name="T:Xunit.Sdk.NotInRangeException">
  1325. <summary>
  1326. Exception thrown when a value is unexpectedly in the given range.
  1327. </summary>
  1328. </member>
  1329. <member name="M:Xunit.Sdk.NotInRangeException.#ctor(System.Object,System.Object,System.Object)">
  1330. <summary>
  1331. Creates a new instance of the <see cref="T:Xunit.Sdk.NotInRangeException"/> class.
  1332. </summary>
  1333. <param name="actual">The actual object value</param>
  1334. <param name="low">The low value of the range</param>
  1335. <param name="high">The high value of the range</param>
  1336. </member>
  1337. <member name="P:Xunit.Sdk.NotInRangeException.Actual">
  1338. <summary>
  1339. Gets the actual object value
  1340. </summary>
  1341. </member>
  1342. <member name="P:Xunit.Sdk.NotInRangeException.High">
  1343. <summary>
  1344. Gets the high value of the range
  1345. </summary>
  1346. </member>
  1347. <member name="P:Xunit.Sdk.NotInRangeException.Low">
  1348. <summary>
  1349. Gets the low value of the range
  1350. </summary>
  1351. </member>
  1352. <member name="P:Xunit.Sdk.NotInRangeException.Message">
  1353. <summary>
  1354. Gets a message that describes the current exception.
  1355. </summary>
  1356. <returns>The error message that explains the reason for the exception, or an empty string("").</returns>
  1357. </member>
  1358. <member name="T:Xunit.Sdk.NotNullException">
  1359. <summary>
  1360. Exception thrown when an object is unexpectedly null.
  1361. </summary>
  1362. </member>
  1363. <member name="M:Xunit.Sdk.NotNullException.#ctor">
  1364. <summary>
  1365. Creates a new instance of the <see cref="T:Xunit.Sdk.NotNullException"/> class.
  1366. </summary>
  1367. </member>
  1368. <member name="T:Xunit.Sdk.NotSameException">
  1369. <summary>
  1370. Exception thrown when two values are unexpected the same instance.
  1371. </summary>
  1372. </member>
  1373. <member name="M:Xunit.Sdk.NotSameException.#ctor">
  1374. <summary>
  1375. Creates a new instance of the <see cref="T:Xunit.Sdk.NotSameException"/> class.
  1376. </summary>
  1377. </member>
  1378. <member name="T:Xunit.Sdk.NullException">
  1379. <summary>
  1380. Exception thrown when an object reference is unexpectedly not null.
  1381. </summary>
  1382. </member>
  1383. <member name="M:Xunit.Sdk.NullException.#ctor(System.Object)">
  1384. <summary>
  1385. Creates a new instance of the <see cref="T:Xunit.Sdk.NullException"/> class.
  1386. </summary>
  1387. <param name="actual"></param>
  1388. </member>
  1389. <member name="T:Xunit.Sdk.ParameterCountMismatchException">
  1390. <summary>
  1391. Exception to be thrown from theory execution when the number of
  1392. parameter values does not the test method signature.
  1393. </summary>
  1394. </member>
  1395. <member name="T:Xunit.Sdk.ProperSubsetException">
  1396. <summary>
  1397. Exception thrown when a set is not a proper subset of another set.
  1398. </summary>
  1399. </member>
  1400. <member name="M:Xunit.Sdk.ProperSubsetException.#ctor(System.Collections.IEnumerable,System.Collections.IEnumerable)">
  1401. <summary>
  1402. Creates a new instance of the <see cref="T:Xunit.Sdk.ProperSubsetException"/> class.
  1403. </summary>
  1404. </member>
  1405. <member name="T:Xunit.Sdk.ProperSupersetException">
  1406. <summary>
  1407. Exception thrown when a set is not a proper superset of another set.
  1408. </summary>
  1409. </member>
  1410. <member name="M:Xunit.Sdk.ProperSupersetException.#ctor(System.Collections.IEnumerable,System.Collections.IEnumerable)">
  1411. <summary>
  1412. Creates a new instance of the <see cref="T:Xunit.Sdk.ProperSupersetException"/> class.
  1413. </summary>
  1414. </member>
  1415. <member name="T:Xunit.Sdk.PropertyChangedException">
  1416. <summary>
  1417. Exception thrown when code unexpectedly fails change a property.
  1418. </summary>
  1419. </member>
  1420. <member name="M:Xunit.Sdk.PropertyChangedException.#ctor(System.String)">
  1421. <summary>
  1422. Creates a new instance of the <see cref="T:Xunit.Sdk.PropertyChangedException"/> class. Call this constructor
  1423. when no exception was thrown.
  1424. </summary>
  1425. <param name="propertyName">The name of the property that was expected to be changed.</param>
  1426. </member>
  1427. <member name="T:Xunit.Sdk.RaisesException">
  1428. <summary>
  1429. Exception thrown when code unexpectedly fails to raise an event.
  1430. </summary>
  1431. </member>
  1432. <member name="M:Xunit.Sdk.RaisesException.#ctor(System.Type)">
  1433. <summary>
  1434. Creates a new instance of the <see cref="T:Xunit.Sdk.RaisesException" /> class. Call this constructor
  1435. when no event was raised.
  1436. </summary>
  1437. <param name="expected">The type of the event args that was expected</param>
  1438. </member>
  1439. <member name="M:Xunit.Sdk.RaisesException.#ctor(System.Type,System.Type)">
  1440. <summary>
  1441. Creates a new instance of the <see cref="T:Xunit.Sdk.RaisesException" /> class. Call this constructor
  1442. when an
  1443. </summary>
  1444. <param name="expected"></param>
  1445. <param name="actual"></param>
  1446. </member>
  1447. <member name="P:Xunit.Sdk.RaisesException.Actual">
  1448. <summary>
  1449. Gets the actual value.
  1450. </summary>
  1451. </member>
  1452. <member name="P:Xunit.Sdk.RaisesException.Expected">
  1453. <summary>
  1454. Gets the expected value.
  1455. </summary>
  1456. </member>
  1457. <member name="P:Xunit.Sdk.RaisesException.Message">
  1458. <summary>
  1459. Gets a message that describes the current exception. Includes the expected and actual values.
  1460. </summary>
  1461. <returns>The error message that explains the reason for the exception, or an empty string("").</returns>
  1462. <filterpriority>1</filterpriority>
  1463. </member>
  1464. <member name="P:Xunit.Sdk.RaisesException.StackTrace">
  1465. <summary>
  1466. Gets a string representation of the frames on the call stack at the time the current exception was thrown.
  1467. </summary>
  1468. <returns>A string that describes the contents of the call stack, with the most recent method call appearing first.</returns>
  1469. </member>
  1470. <member name="T:Xunit.Sdk.SameException">
  1471. <summary>
  1472. Exception thrown when two object references are unexpectedly not the same instance.
  1473. </summary>
  1474. </member>
  1475. <member name="M:Xunit.Sdk.SameException.#ctor(System.Object,System.Object)">
  1476. <summary>
  1477. Creates a new instance of the <see cref="T:Xunit.Sdk.SameException"/> class.
  1478. </summary>
  1479. <param name="expected">The expected object reference</param>
  1480. <param name="actual">The actual object reference</param>
  1481. </member>
  1482. <member name="T:Xunit.Sdk.SingleException">
  1483. <summary>
  1484. Exception thrown when the collection did not contain exactly one element.
  1485. </summary>
  1486. </member>
  1487. <member name="M:Xunit.Sdk.SingleException.#ctor(System.String)">
  1488. <summary>
  1489. Initializes a new instance of the <see cref="T:Xunit.Sdk.SingleException"/> class.
  1490. </summary>
  1491. </member>
  1492. <member name="M:Xunit.Sdk.SingleException.Empty">
  1493. <summary>
  1494. Creates an instance of <see cref="T:Xunit.Sdk.SingleException"/> for when the collection was empty.
  1495. </summary>
  1496. </member>
  1497. <member name="M:Xunit.Sdk.SingleException.MoreThanOne">
  1498. <summary>
  1499. Creates an instance of <see cref="T:Xunit.Sdk.SingleException"/> for when the collection had too many items.
  1500. </summary>
  1501. <returns></returns>
  1502. </member>
  1503. <member name="T:Xunit.Sdk.StartsWithException">
  1504. <summary>
  1505. Exception thrown when a string does not start with the expected value.
  1506. </summary>
  1507. </member>
  1508. <member name="M:Xunit.Sdk.StartsWithException.#ctor(System.String,System.String)">
  1509. <summary>
  1510. Creates a new instance of the <see cref="T:Xunit.Sdk.StartsWithException"/> class.
  1511. </summary>
  1512. <param name="expected">The expected string value</param>
  1513. <param name="actual">The actual value</param>
  1514. </member>
  1515. <member name="T:Xunit.Sdk.SubsetException">
  1516. <summary>
  1517. Exception thrown when a set is not a subset of another set.
  1518. </summary>
  1519. </member>
  1520. <member name="M:Xunit.Sdk.SubsetException.#ctor(System.Collections.IEnumerable,System.Collections.IEnumerable)">
  1521. <summary>
  1522. Creates a new instance of the <see cref="T:Xunit.Sdk.SubsetException"/> class.
  1523. </summary>
  1524. </member>
  1525. <member name="T:Xunit.Sdk.SupersetException">
  1526. <summary>
  1527. Exception thrown when a set is not a superset of another set.
  1528. </summary>
  1529. </member>
  1530. <member name="M:Xunit.Sdk.SupersetException.#ctor(System.Collections.IEnumerable,System.Collections.IEnumerable)">
  1531. <summary>
  1532. Creates a new instance of the <see cref="T:Xunit.Sdk.SupersetException"/> class.
  1533. </summary>
  1534. </member>
  1535. <member name="T:Xunit.Sdk.ThrowsException">
  1536. <summary>
  1537. Exception thrown when code unexpectedly fails to throw an exception.
  1538. </summary>
  1539. </member>
  1540. <member name="M:Xunit.Sdk.ThrowsException.#ctor(System.Type)">
  1541. <summary>
  1542. Creates a new instance of the <see cref="T:Xunit.Sdk.ThrowsException"/> class. Call this constructor
  1543. when no exception was thrown.
  1544. </summary>
  1545. <param name="expectedType">The type of the exception that was expected</param>
  1546. </member>
  1547. <member name="M:Xunit.Sdk.ThrowsException.#ctor(System.Type,System.Exception)">
  1548. <summary>
  1549. Creates a new instance of the <see cref="T:Xunit.Sdk.ThrowsException"/> class. Call this constructor
  1550. when an exception of the wrong type was thrown.
  1551. </summary>
  1552. <param name="expectedType">The type of the exception that was expected</param>
  1553. <param name="actual">The actual exception that was thrown</param>
  1554. </member>
  1555. <member name="M:Xunit.Sdk.ThrowsException.#ctor(System.Type,System.String,System.String,System.String,System.Exception)">
  1556. <summary>
  1557. THIS CONSTRUCTOR IS FOR UNIT TESTING PURPOSES ONLY.
  1558. </summary>
  1559. </member>
  1560. <member name="P:Xunit.Sdk.ThrowsException.StackTrace">
  1561. <summary>
  1562. Gets a string representation of the frames on the call stack at the time the current exception was thrown.
  1563. </summary>
  1564. <returns>A string that describes the contents of the call stack, with the most recent method call appearing first.</returns>
  1565. </member>
  1566. <member name="T:Xunit.Sdk.TrueException">
  1567. <summary>
  1568. Exception thrown when a value is unexpectedly false.
  1569. </summary>
  1570. </member>
  1571. <member name="M:Xunit.Sdk.TrueException.#ctor(System.String,System.Nullable{System.Boolean})">
  1572. <summary>
  1573. Creates a new instance of the <see cref="T:Xunit.Sdk.TrueException"/> class.
  1574. </summary>
  1575. <param name="userMessage">The user message to be displayed, or null for the default message</param>
  1576. <param name="value">The actual value</param>
  1577. </member>
  1578. <member name="T:Xunit.Sdk.XunitException">
  1579. <summary>
  1580. The base assert exception class
  1581. </summary>
  1582. </member>
  1583. <member name="M:Xunit.Sdk.XunitException.#ctor">
  1584. <summary>
  1585. Initializes a new instance of the <see cref="T:Xunit.Sdk.XunitException"/> class.
  1586. </summary>
  1587. </member>
  1588. <member name="M:Xunit.Sdk.XunitException.#ctor(System.String)">
  1589. <summary>
  1590. Initializes a new instance of the <see cref="T:Xunit.Sdk.XunitException"/> class.
  1591. </summary>
  1592. <param name="userMessage">The user message to be displayed</param>
  1593. </member>
  1594. <member name="M:Xunit.Sdk.XunitException.#ctor(System.String,System.Exception)">
  1595. <summary>
  1596. Initializes a new instance of the <see cref="T:Xunit.Sdk.XunitException"/> class.
  1597. </summary>
  1598. <param name="userMessage">The user message to be displayed</param>
  1599. <param name="innerException">The inner exception</param>
  1600. </member>
  1601. <member name="M:Xunit.Sdk.XunitException.#ctor(System.String,System.String)">
  1602. <summary>
  1603. Initializes a new instance of the <see cref="T:Xunit.Sdk.XunitException"/> class.
  1604. </summary>
  1605. <param name="userMessage">The user message to be displayed</param>
  1606. <param name="stackTrace">The stack trace to be displayed</param>
  1607. </member>
  1608. <member name="P:Xunit.Sdk.XunitException.StackTrace">
  1609. <summary>
  1610. Gets a string representation of the frames on the call stack at the time the current exception was thrown.
  1611. </summary>
  1612. <returns>A string that describes the contents of the call stack, with the most recent method call appearing first.</returns>
  1613. </member>
  1614. <member name="P:Xunit.Sdk.XunitException.UserMessage">
  1615. <summary>
  1616. Gets the user message
  1617. </summary>
  1618. </member>
  1619. <member name="M:Xunit.Sdk.XunitException.ToString">
  1620. <inheritdoc/>
  1621. </member>
  1622. </members>
  1623. </doc>